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

   1 // \r
   2 // System.Xml.Serialization.XmlCodeExporter \r
   3 //\r
   4 // Author:\r
   5 //   Tim Coleman (tim@timcoleman.com)\r
   6 //   Lluis Sanchez Gual (lluis@ximian.com)\r
   7 //\r
   8 // Copyright (C) Tim Coleman, 2002\r
   9 //\r
  10 \r
  11 using System.CodeDom;\r
  12 using System.Collections;\r
  13 using System.Xml.Schema;\r
  14 \r
  15 namespace System.Xml.Serialization {\r
  16         public class XmlCodeExporter {\r
  17 \r
  18                 #region Fields\r
  19 \r
  20                 CodeNamespace codeNamespace;\r
  21                 CodeCompileUnit codeCompileUnit;\r
  22                 bool encodedFormat;\r
  23                 XmlMapCodeGenerator codeGenerator;\r
  24 \r
  25                 Hashtable exportedMaps = new Hashtable ();\r
  26 \r
  27                 #endregion\r
  28 \r
  29                 #region Constructors\r
  30 \r
  31                 public XmlCodeExporter (CodeNamespace codeNamespace): this (codeNamespace, null)\r
  32                 {\r
  33                 }\r
  34 \r
  35                 public XmlCodeExporter (CodeNamespace codeNamespace, CodeCompileUnit codeCompileUnit)\r
  36                 {\r
  37                         this.codeCompileUnit = codeCompileUnit;\r
  38                         this.codeNamespace = codeNamespace;\r
  39                         \r
  40                         codeGenerator = new XmlMapCodeGenerator (codeNamespace, codeCompileUnit);\r
  41                 }\r
  42 \r
  43                 #endregion // Constructors\r
  44 \r
  45                 #region Properties\r
  46 \r
  47                 public CodeAttributeDeclarationCollection IncludeMetadata {\r
  48                         get { return codeGenerator.IncludeMetadata; }\r
  49                 }\r
  50 \r
  51                 #endregion Properties\r
  52 \r
  53                 #region Methods\r
  54 \r
  55                 public void AddMappingMetadata (CodeAttributeDeclarationCollection metadata, XmlMemberMapping member, string ns)\r
  56                 {\r
  57                         AddMappingMetadata (metadata, member, ns, false);\r
  58                 }\r
  59 \r
  60                 [MonoTODO]\r
  61                 public void AddMappingMetadata (CodeAttributeDeclarationCollection metadata, XmlTypeMapping member, string ns)\r
  62                 {\r
  63                         throw new NotImplementedException ();\r
  64                 }\r
  65 \r
  66                 public void AddMappingMetadata (CodeAttributeDeclarationCollection metadata, XmlMemberMapping member, string ns, bool forceUseMemberName)\r
  67                 {\r
  68                         CodeAttributeDeclaration att;\r
  69                         TypeData memType = member.TypeMapMember.TypeData;\r
  70                         \r
  71                         if (member.Any)\r
  72                         {\r
  73                                 XmlTypeMapElementInfoList list = (XmlTypeMapElementInfoList)((XmlTypeMapMemberElement)member.TypeMapMember).ElementInfo;\r
  74                                 foreach (XmlTypeMapElementInfo info in list)\r
  75                                 {\r
  76                                         if (info.IsTextElement)\r
  77                                                 metadata.Add (new CodeAttributeDeclaration ("System.Xml.Serialization.XmlText"));\r
  78                                         else {\r
  79                                                 att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlAnyElement");\r
  80                                                 if (!info.IsUnnamedAnyElement) {\r
  81                                                         att.Arguments.Add (MapCodeGenerator.GetArg ("Name", info.ElementName));\r
  82                                                         if (info.Namespace != ns) att.Arguments.Add (MapCodeGenerator.GetArg ("Namespace", member.Namespace));\r
  83                                                 }\r
  84                                                 metadata.Add (att);\r
  85                                         }\r
  86                                 }\r
  87                         }\r
  88                         else if (member.TypeMapMember is XmlTypeMapMemberList)\r
  89                         {\r
  90                                 // Array parameter\r
  91                                 XmlTypeMapMemberList list = member.TypeMapMember as XmlTypeMapMemberList;\r
  92                                 ListMap listMap = (ListMap) list.ListTypeMapping.ObjectMap;\r
  93                                 \r
  94                                 codeGenerator.AddArrayAttributes (metadata, list, ns, forceUseMemberName);\r
  95                                 codeGenerator.AddArrayItemAttributes (metadata, listMap, memType.ListItemTypeData, list.Namespace, 0);\r
  96                         }\r
  97                         else if (member.TypeMapMember is XmlTypeMapMemberElement) {\r
  98                                 codeGenerator.AddElementMemberAttributes ((XmlTypeMapMemberElement) member.TypeMapMember, ns, metadata, forceUseMemberName);\r
  99                         }\r
 100                         else if (member.TypeMapMember is XmlTypeMapMemberAttribute) {\r
 101                                 codeGenerator.AddAttributeMemberAttributes ((XmlTypeMapMemberAttribute) member.TypeMapMember, ns, metadata, forceUseMemberName);\r
 102                         }\r
 103                         else\r
 104                                 throw new NotSupportedException ("Schema type not supported");\r
 105                 }\r
 106 \r
 107                 public void ExportMembersMapping (XmlMembersMapping xmlMembersMapping)\r
 108                 {\r
 109                         codeGenerator.ExportMembersMapping (xmlMembersMapping);\r
 110                 }\r
 111 \r
 112                 public void ExportTypeMapping (XmlTypeMapping xmlTypeMapping)\r
 113                 {\r
 114                         codeGenerator.ExportTypeMapping (xmlTypeMapping);\r
 115                 }\r
 116 \r
 117                 #endregion // Methods\r
 118         }\r
 119         \r
 120         class XmlMapCodeGenerator : MapCodeGenerator\r
 121         {\r
 122                 public XmlMapCodeGenerator (CodeNamespace codeNamespace, CodeCompileUnit codeCompileUnit)\r
 123                 : base (codeNamespace, codeCompileUnit)\r
 124                 {\r
 125                 }\r
 126 \r
 127                 protected override void GenerateClass (XmlTypeMapping map, CodeTypeDeclaration codeClass)\r
 128                 {\r
 129                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlType");\r
 130                         if (map.XmlType != map.TypeData.TypeName) att.Arguments.Add (GetArg (map.XmlType));\r
 131                         if (map.XmlTypeNamespace != "") att.Arguments.Add (GetArg ("Namespace", map.XmlTypeNamespace));\r
 132                         AddCustomAttribute (codeClass, att, false);\r
 133 \r
 134                         CodeAttributeDeclaration ratt = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlRoot");\r
 135                         if (map.ElementName != map.XmlType) ratt.Arguments.Add (GetArg (map.ElementName));\r
 136                         if (map.Namespace != "") ratt.Arguments.Add (GetArg ("Namespace", map.Namespace));\r
 137                         AddCustomAttribute (codeClass, ratt, false);\r
 138                 }\r
 139                 \r
 140                 protected override void GenerateClassInclude (CodeAttributeDeclarationCollection attributes, XmlTypeMapping map)\r
 141                 {\r
 142                         CodeAttributeDeclaration iatt = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlInclude");\r
 143                         iatt.Arguments.Add (new CodeAttributeArgument (new CodeTypeOfExpression(map.TypeData.FullTypeName)));\r
 144                         attributes.Add (iatt);\r
 145                 }\r
 146                 \r
 147                 protected override void GenerateAnyAttribute (CodeMemberField codeField)\r
 148                 {\r
 149                         AddCustomAttribute (codeField, "System.Xml.Serialization.XmlAnyAttribute");\r
 150                 }\r
 151                 \r
 152                 protected override void GenerateAttributeMember (CodeAttributeDeclarationCollection attributes, XmlTypeMapMemberAttribute attinfo, string defaultNamespace, bool forceUseMemberName)\r
 153                 {\r
 154                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlAttribute");\r
 155                         if (forceUseMemberName || attinfo.Name != attinfo.AttributeName) att.Arguments.Add (GetArg (attinfo.AttributeName));\r
 156                         if (attinfo.Namespace != defaultNamespace) att.Arguments.Add (GetArg ("Namespace", attinfo.Namespace));\r
 157                         if (attinfo.Form != XmlSchemaForm.None) att.Arguments.Add (GetEnumArg ("Form","System.Xml.Schema.XmlSchemaForm",attinfo.Form.ToString()));\r
 158                         if (!TypeTranslator.IsDefaultPrimitiveTpeData(attinfo.TypeData)) att.Arguments.Add (GetArg ("DataType",attinfo.TypeData.XmlType));\r
 159                         attributes.Add (att);\r
 160                 }\r
 161                 \r
 162                 protected override void GenerateElementInfoMember (CodeAttributeDeclarationCollection attributes, XmlTypeMapMemberElement member, XmlTypeMapElementInfo einfo, TypeData defaultType, string defaultNamespace, bool addAlwaysAttr, bool forceUseMemberName)\r
 163                 {\r
 164                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlElement");\r
 165                         if (forceUseMemberName || einfo.ElementName != member.Name) att.Arguments.Add (GetArg (einfo.ElementName));\r
 166                         if (einfo.TypeData.FullTypeName != defaultType.FullTypeName) att.Arguments.Add (GetTypeArg ("Type", einfo.TypeData.FullTypeName));\r
 167                         if (einfo.Namespace != defaultNamespace) att.Arguments.Add (GetArg ("Namespace", einfo.Namespace));\r
 168                         if (einfo.Form == XmlSchemaForm.Unqualified) att.Arguments.Add (GetEnumArg ("Form", "System.Xml.Schema.XmlSchemaForm", einfo.Form.ToString()));\r
 169                         if (einfo.IsNullable) att.Arguments.Add (GetArg ("IsNullable", true));\r
 170                         if (!TypeTranslator.IsDefaultPrimitiveTpeData(einfo.TypeData)) att.Arguments.Add (GetArg ("DataType",einfo.TypeData.XmlType));\r
 171                         if (addAlwaysAttr || att.Arguments.Count > 0) attributes.Add (att);\r
 172                 }\r
 173                 \r
 174                 protected override void GenerateElementMember (CodeAttributeDeclarationCollection attributes, XmlTypeMapMemberElement member)\r
 175                 {\r
 176                         if (member.ChoiceMember != null) {\r
 177                                 CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlChoiceIdentifier");\r
 178                                 att.Arguments.Add (GetArg(member.ChoiceMember));\r
 179                                 attributes.Add (att);\r
 180                         }\r
 181                 }\r
 182                 \r
 183                 protected override void GenerateArrayElement (CodeAttributeDeclarationCollection attributes, XmlTypeMapMemberElement member, string defaultNamespace, bool forceUseMemberName)\r
 184                 {\r
 185                         XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) member.ElementInfo[0];\r
 186                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlArray");\r
 187                         if (forceUseMemberName || (einfo.ElementName != member.Name)) att.Arguments.Add (GetArg ("ElementName", einfo.ElementName));\r
 188                         if (einfo.Namespace != defaultNamespace) att.Arguments.Add (GetArg ("Namespace", einfo.Namespace));\r
 189                         if (einfo.Form == XmlSchemaForm.Unqualified) att.Arguments.Add (MapCodeGenerator.GetEnumArg ("Form", "System.Xml.Schema.XmlSchemaForm", einfo.Form.ToString()));\r
 190                         if (einfo.IsNullable) att.Arguments.Add (GetArg ("IsNullable", true));\r
 191                         if (att.Arguments.Count > 0) attributes.Add (att);\r
 192                 }\r
 193                 \r
 194                 protected override void GenerateArrayItemAttributes (CodeAttributeDeclarationCollection attributes, ListMap listMap, TypeData type, XmlTypeMapElementInfo ainfo, string defaultName, string defaultNamespace, int nestingLevel)\r
 195                 {\r
 196                         bool needsType = (listMap.ItemInfo.Count > 1) ||\r
 197                                                          (ainfo.TypeData.FullTypeName != type.FullTypeName && !listMap.IsMultiArray);\r
 198 \r
 199                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlArrayItem");\r
 200                         if (ainfo.ElementName != defaultName) att.Arguments.Add (GetArg ("ElementName", ainfo.ElementName));\r
 201                         if (ainfo.Namespace != defaultNamespace && ainfo.Namespace != XmlSchema.Namespace) att.Arguments.Add (GetArg ("Namespace", ainfo.Namespace));\r
 202                         if (needsType) att.Arguments.Add (GetTypeArg ("Type", ainfo.TypeData.FullTypeName));\r
 203                         if (!ainfo.IsNullable) att.Arguments.Add (GetArg ("IsNullable", false));\r
 204                         if (ainfo.Form == XmlSchemaForm.Unqualified) att.Arguments.Add (MapCodeGenerator.GetEnumArg ("Form", "System.Xml.Schema.XmlSchemaForm", ainfo.Form.ToString()));\r
 205                         if (att.Arguments.Count > 0 && nestingLevel > 0) att.Arguments.Add (GetArg ("NestingLevel", nestingLevel));\r
 206                         \r
 207                         if (att.Arguments.Count > 0) attributes.Add (att);\r
 208                 }\r
 209 \r
 210                 protected override void GenerateTextElementAttribute (CodeAttributeDeclarationCollection attributes, XmlTypeMapElementInfo einfo, TypeData defaultType)\r
 211                 {\r
 212                         CodeAttributeDeclaration uatt = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlText");\r
 213                         if (einfo.TypeData.FullTypeName != defaultType.FullTypeName) uatt.Arguments.Add (GetTypeArg ("Type", einfo.TypeData.FullTypeName));\r
 214                         attributes.Add (uatt);\r
 215                 }\r
 216                 \r
 217                 protected override void GenerateUnnamedAnyElementAttribute (CodeAttributeDeclarationCollection attributes, XmlTypeMapElementInfo einfo, string defaultNamespace)\r
 218                 {\r
 219                         CodeAttributeDeclaration uatt = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlAnyElement");\r
 220                         if (!einfo.IsUnnamedAnyElement) uatt.Arguments.Add (GetArg ("Name", einfo.ElementName));\r
 221                         if (einfo.Namespace != defaultNamespace) uatt.Arguments.Add (GetArg ("Namespace", einfo.Namespace));\r
 222                         attributes.Add (uatt);\r
 223                 }\r
 224                 \r
 225                 protected override void GenerateEnum (XmlTypeMapping map, CodeTypeDeclaration codeEnum)\r
 226                 {\r
 227                         CodeAttributeDeclaration att = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlTypeAttribute");\r
 228                         if (map.XmlType != map.TypeData.TypeName) att.Arguments.Add (GetArg ("TypeName", map.XmlType));\r
 229                         if (map.XmlTypeNamespace != "") att.Arguments.Add (GetArg ("Namespace", map.XmlTypeNamespace));\r
 230                         AddCustomAttribute (codeEnum, att, false);\r
 231                 }               \r
 232                 \r
 233                 protected override void GenerateEnumItem (CodeMemberField codeField, EnumMap.EnumMapMember emem)\r
 234                 {\r
 235                         if (emem.EnumName != emem.XmlName)\r
 236                         {\r
 237                                 CodeAttributeDeclaration xatt = new CodeAttributeDeclaration ("System.Xml.Serialization.XmlEnum");\r
 238                                 xatt.Arguments.Add (GetArg ("Name", emem.XmlName));\r
 239 \r
 240                                 AddCustomAttribute (codeField, xatt, true);\r
 241                         }\r
 242                 }\r
 243                 \r
 244                 protected override void GenerateSpecifierMember (CodeMemberField codeField)\r
 245                 {\r
 246                         AddCustomAttribute (codeField, "System.Xml.Serialization.XmlIgnore");\r
 247                 }\r
 248 \r
 249         }\r
 250 }