class/corlib/System.Runtime.Serialization/Formatter.cs

   1 //
   2 // System.Runtime.Serialization.Formatter.cs
   3 //
   4 // Authors:
   5 //   Duncan Mak  (duncan@ximian.com)
   6 //   Andreas Nahr (ClassDevelopment@A-SoftTech.com)
   7 //
   8 // (C) Ximian, Inc.
   9 //
  10
  11 //
  12 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining
  15 // a copy of this software and associated documentation files (the
  16 // "Software"), to deal in the Software without restriction, including
  17 // without limitation the rights to use, copy, modify, merge, publish,
  18 // distribute, sublicense, and/or sell copies of the Software, and to
  19 // permit persons to whom the Software is furnished to do so, subject to
  20 // the following conditions:
  21 //
  22 // The above copyright notice and this permission notice shall be
  23 // included in all copies or substantial portions of the Software.
  24 //
  25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 //
  33
  34 using System;
  35 using System.Collections;
  36 using System.IO;
  37
  38 namespace System.Runtime.Serialization
  39 {
  40 [CLSCompliant (false)]
  41 [Serializable]
  42 #if NET_2_0
  43 [System.Runtime.InteropServices.ComVisibleAttribute (true)]
  44 #endif
  45 public abstract class Formatter : IFormatter
  46 {
  47         protected Formatter ()
  48         {
  49         }
  50
  51         protected ObjectIDGenerator m_idGenerator = new ObjectIDGenerator ();
  52         protected Queue m_objectQueue = new Queue ();
  53
  54         public abstract SerializationBinder Binder {
  55                 get;
  56                 set;
  57         }
  58
  59         public abstract StreamingContext Context {
  60                 get;
  61                 set;
  62         }
  63
  64         public abstract ISurrogateSelector SurrogateSelector {
  65                 get;
  66                 set;
  67         }
  68
  69         public abstract object Deserialize (Stream serializationStream);
  70
  71         protected virtual object GetNext (out long objID)
  72         {
  73                 if (m_objectQueue.Count == 0)
  74                 {
  75                         // set the out field to 0
  76                         objID = 0L;
  77                         return null;
  78                 }
  79
  80                 Object o = m_objectQueue.Dequeue ();
  81                 bool FirstTime;
  82                 objID = m_idGenerator.HasId (o, out FirstTime);
  83
  84                 return o;
  85         }
  86
  87         protected virtual long Schedule (object obj)
  88         {
  89                 if (obj == null)
  90                         return 0L;
  91
  92                 bool FirstTime;
  93                 long ID = m_idGenerator.GetId (obj, out FirstTime);
  94                 if (FirstTime)
  95                         m_objectQueue.Enqueue (obj);
  96
  97                 return ID;
  98         }
  99
 100         public abstract void Serialize (Stream serializationStream, object graph);
 101
 102         protected abstract void WriteArray (object obj, string name, Type memberType);
 103
 104         protected abstract void WriteBoolean (bool val, string name);
 105
 106         protected abstract void WriteByte (byte val, string name);
 107
 108         protected abstract void WriteChar (char val, string name);
 109
 110         protected abstract void WriteDateTime (DateTime val, string name);
 111
 112         protected abstract void WriteDecimal (Decimal val, string name);
 113
 114         protected abstract void WriteDouble (double val, string name);
 115
 116         protected abstract void WriteInt16 (short val, string name);
 117
 118         protected abstract void WriteInt32 (int val, string name);
 119
 120         protected abstract void WriteInt64 (long val, string name);
 121
 122         protected virtual void WriteMember (string memberName, object data)
 123         {
 124                 if (data == null)
 125                         WriteObjectRef (data, memberName, typeof(Object));
 126
 127                 Type dataType = data.GetType ();
 128                 if (dataType.IsArray)
 129                         WriteArray (data, memberName, dataType);
 130                 else if (dataType == typeof(bool))
 131                         WriteBoolean ((bool)data, memberName);
 132                 else if (dataType == typeof(byte))
 133                         WriteByte ((byte)data, memberName);
 134                 else if (dataType == typeof(char))
 135                         WriteChar ((char)data, memberName);
 136                 else if (dataType == typeof(DateTime))
 137                         WriteDateTime ((DateTime)data, memberName);
 138                 else if (dataType == typeof(decimal))
 139                         WriteDecimal ((decimal)data, memberName);
 140                 else if (dataType == typeof(double))
 141                         WriteDouble ((double)data, memberName);
 142                 else if (dataType == typeof(Int16))
 143                         WriteInt16 ((Int16)data, memberName);
 144                 else if (dataType == typeof(Int32))
 145                         WriteInt32 ((Int32)data, memberName);
 146                 else if (dataType == typeof(Int64))
 147                         WriteInt64 ((Int64)data, memberName);
 148                 else if (dataType == typeof(sbyte))
 149                         WriteSByte ((sbyte)data, memberName);
 150                 else if (dataType == typeof(float))
 151                         WriteSingle ((float)data, memberName);
 152                 else if (dataType == typeof(TimeSpan))
 153                         WriteTimeSpan ((TimeSpan)data, memberName);
 154                 else if (dataType == typeof(UInt16))
 155                         WriteUInt16 ((UInt16)data, memberName);
 156                 else if (dataType == typeof(UInt32))
 157                         WriteUInt32 ((UInt32)data, memberName);
 158                 else if (dataType == typeof(UInt64))
 159                         WriteUInt64 ((UInt64)data, memberName);
 160                 else if (dataType.IsValueType)
 161                         WriteValueType (data, memberName, dataType);
 162
 163                 WriteObjectRef (data, memberName, dataType);
 164         }
 165
 166         protected abstract void WriteObjectRef (object obj, string name, Type memberType);
 167
 168
 169         [CLSCompliant (false)]
 170         protected abstract void WriteSByte (sbyte val, string name);
 171
 172
 173         protected abstract void WriteSingle (float val, string name);
 174
 175         protected abstract void WriteTimeSpan (TimeSpan val, string name);
 176
 177         [CLSCompliant (false)]
 178         protected abstract void WriteUInt16 (ushort val, string name);
 179
 180         [CLSCompliant (false)]
 181         protected abstract void WriteUInt32 (uint val, string name);
 182
 183         [CLSCompliant (false)]
 184         protected abstract void WriteUInt64 (ulong val, string name);
 185
 186         protected abstract void WriteValueType (object obj, string name, Type memberType);
 187 }
 188 }