mcs/class/corlib/System.Runtime.Serialization/ObjectIDGenerator.cs

   1 //
   2 // System.Runtime.Serialization.ObjectIDGenerator.cs
   3 //
   4 // Author: Duncan Mak  (duncan@ximian.com)
   5 //         Lluis Sanchez (lsg@ctv.es)
   6 //
   7 // (C) Ximian, Inc.
   8 // Copyright (C) 2004,2006 Novell, Inc (http://www.novell.com)
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 //
  29
  30 using System.Collections;
  31
  32 namespace System.Runtime.Serialization
  33 {
  34         [Serializable]
  35         [MonoTODO ("Serialization format not compatible with.NET")]
  36 #if NET_2_0
  37         [System.Runtime.InteropServices.ComVisibleAttribute (true)]
  38 #endif
  39         public class ObjectIDGenerator
  40         {
  41                 // Private field
  42                 Hashtable table;
  43                 long current; // this is the current ID, starts at 1
  44                 static InstanceComparer comparer = new InstanceComparer ();
  45
  46
  47                 // ObjectIDGenerator must generate a new id for each object instance.
  48                 // If two objects have the same state (i.e. the method Equals() returns true),
  49                 // each one should have a different id.
  50                 // Thus, the object instance cannot be directly used as key of the hashtable.
  51                 // InstanceComparer compares object references instead of object content
  52                 // (unless the object is inmutable, like strings).
  53
  54                 class InstanceComparer: IComparer, IHashCodeProvider
  55                 {
  56                         int IComparer.Compare (object o1, object o2)
  57                         {
  58                                 if (o1 is string)
  59                                         return o1.Equals(o2) ? 0 : 1;
  60                                 else
  61                                         return (o1 == o2) ? 0 : 1;
  62                         }
  63
  64                         int IHashCodeProvider.GetHashCode (object o)
  65                         {
  66                                 return object.InternalGetHashCode (o);
  67                         }
  68                 }
  69
  70                 // constructor
  71                 public ObjectIDGenerator ()
  72                         : base ()
  73                 {
  74                         table = new Hashtable (comparer, comparer);
  75                         current = 1;
  76                 }
  77
  78                 // Methods
  79                 public virtual long GetId (object obj, out bool firstTime)
  80                 {
  81                         if (obj == null)
  82                                 throw new ArgumentNullException ("obj");
  83
  84                         object val = table [obj];
  85
  86                         if (val != null) {
  87                                 firstTime = false;
  88                                 return (long) val;
  89
  90                         } else {
  91                                 firstTime = true;
  92                                 table.Add (obj, current);
  93                                 return current ++;
  94                         }
  95                 }
  96
  97                 public virtual long HasId (object obj, out bool firstTime)
  98                 {
  99                         if (obj == null)
 100                                 throw new ArgumentNullException ("obj");
 101
 102                         object val = table [obj];
 103
 104                         if (val != null) {
 105                                 firstTime = false;
 106                                 return (long) val;
 107
 108                         } else {
 109                                 firstTime = true;
 110                                 return 0L; // 0 is the null ID
 111                         }
 112                 }
 113
 114                 internal long NextId
 115                 {
 116                         get { return current ++; }
 117                 }
 118         }
 119 }