Tweaks

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@15654 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -4,6 +4,15 @@
 	* Source/Additions/Unicode.m: Added built-in support for the Latin9
 	character encoding ... contains the Euro symbol ... nice for
 	european users.
+	* Source/NSArray.m: Make abstract copying implementation like that
+	of latest MacOS-X rather than OPENSTEP ... no relationship between
+	mutability and depth.
+	* Source/NSDictionary.m: ditto
+	* Source/NSSet.m: ditto
+	* Source/GSArray.m: Implement optimised copies ... copying an immutable
+	object just retains it, and copying a mutable object is shallow.
+	* Source/GSDictionary.m: ditto
+	* Source/GSSet.m: ditto
 
 2003-01-16  Richard Frith-Macdonald <rfm@gnu.org>
 

Headers/gnustep/base/NSObject.h

@@ -90,17 +90,47 @@
 @end
 
 /**
- * This protocol must be adopted by any class wishing to support copying.
+ * This protocol must be adopted by any class wishing to support copying -
+ * ie where instances of the class should be able to create new instances
+ * which are copies of the original and, where a class has mutable and
+ * immutable versions, where the copies are immutable.
  */
 @protocol NSCopying
+/**
+ * Called by [NSObject-copy] passing NSDefaultMallocZone() as zone.<br />
+ * This method returns a copy of the receiver and, where the receiver is a
+ * mutable variant of a class which has an immutable partner class, the
+ * object returned is an instance of that immutable class.<br />
+ * The new object is <em>not</em> autoreleased, and is considered to be
+ * 'owned' by the calling code ... which is therefore responsible for
+ * releasing it.<br />
+ * In the case where the receiver is an instance of a container class,
+ * it is undefined whether contained objects are merely retained in the
+ * new copy, or are themselves copied, or whether some other mechanism
+ * entirely is used.
+ */
 - (id) copyWithZone: (NSZone*)zone;
 @end
 
 /**
  * This protocol must be adopted by any class wishing to support
- * mutable copying.
+ * mutable copying - ie where instances of the class should be able
+ * to create mutable copies of themselves.
  */
 @protocol NSMutableCopying
+/**
+ * Called by [NSObject-mutableCopy] passing NSDefaultMallocZone() as zone.<br />
+ * This method returns a copy of the receiver and, where the receiver is an
+ * immmutable variant of a class which has a mutable partner class, the
+ * object returned is an instance of that mutable class.
+ * The new object is <em>not</em> autoreleased, and is considered to be
+ * 'owned' by the calling code ... which is therefore responsible for
+ * releasing it.<br />
+ * In the case where the receiver is an instance of a container class,
+ * it is undefined whether contained objects are merely retained in the
+ * new copy, or are themselves copied, or whether some other mechanism
+ * entirely is used.
+ */
 - (id) mutableCopyWithZone: (NSZone*)zone;
 @end
 

Source/GSArray.m

@@ -34,6 +34,8 @@
 
 static SEL	eqSel;
 
+static Class	GSInlineArrayClass;
+
 @class	GSArrayEnumerator;
 @class	GSArrayEnumeratorReverse;
 
@@ -73,6 +75,7 @@ static SEL	eqSel;
     {
       [self setVersion: 1];
       eqSel = @selector(isEqual:);
+      GSInlineArrayClass = [GSInlineArray class];
     }
 }
 
@@ -83,6 +86,11 @@ static SEL	eqSel;
   return array;
 }
 
+- (id) copyWithZone: (NSZone*)zone
+{
+  return RETAIN(self);	// Optimised version
+}
+
 - (void) dealloc
 {
   if (_contents_array)
@@ -357,6 +365,17 @@ static SEL	eqSel;
   _count++;	/* Do this AFTER we have retained the object.	*/
 }
 
+/**
+ * Optimised code for copying
+ */
+- (id) copyWithZone: (NSZone*)zone
+{
+  NSArray       *copy;
+
+  copy = (id)NSAllocateObject(GSInlineArrayClass, sizeof(id)*_count, zone);
+  return [copy initWithObjects: _contents_array count: _count];
+}
+
 - (void) exchangeObjectAtIndex: (unsigned int)i1 
              withObjectAtIndex: (unsigned int)i2
 {
@@ -892,8 +911,6 @@ static SEL	eqSel;
 
 @implementation	GSPlaceholderArray
 
-static Class	GSInlineArrayClass;
-
 + (void) initialize
 {
   GSInlineArrayClass = [GSInlineArray class];

Source/GSDictionary.m

@@ -84,6 +84,11 @@ static SEL	objSel;
     }
 }
 
+- (id) copyWithZone: (NSZone*)zone
+{
+  return RETAIN(self);
+}
+
 - (unsigned) count
 {
   return map.nodeCount;
@@ -277,6 +282,13 @@ static SEL	objSel;
     }
 }
 
+- (id) copyWithZone: (NSZone*)zone
+{
+  NSDictionary	*copy = [GSDictionary allocWithZone: zone];
+
+  return [copy initWithDictionary: self copyItems: NO];
+}
+
 /* Designated initialiser */
 - (id) initWithCapacity: (unsigned)cap
 {

Source/GSSet.m

@@ -144,6 +144,11 @@ static Class	mutableSetClass;
     }
 }
 
+- (id) copyWithZone: (NSZone*)z
+{
+  return RETAIN(self);
+}
+
 - (unsigned) count
 {
   return map.nodeCount;
@@ -504,6 +509,14 @@ static Class	mutableSetClass;
     }
 }
 
+/* Override version from GSSet */
+- (id) copyWithZone: (NSZone*)z
+{
+  NSSet	*copy = [setClass allocWithZone: z];
+
+  return [copy initWithSet: self copyItems: NO];
+}
+
 /* Designated initialiser */
 - (id) initWithCapacity: (unsigned)cap
 {

Source/NSArray.m

@@ -306,12 +306,16 @@ static SEL	rlSel;
 }
 
 /**
- * The default NSArray implemntation of a copy is simply to -retain
- * the receiver and return it.
+ * Returns a new copy of the receiver.<br />
+ * The default abstract implementation of a copy is to use the
+ * -initWithArray:copyItems: method with the flag set to YES.<br />
+ * Immutable subclasses generally simply retain and return the receiver.
  */
 - (id) copyWithZone: (NSZone*)zone
 {
-  return RETAIN(self);
+  NSArray	*copy = [NSArrayClass allocWithZone: zone];
+
+  return [copy initWithArray: self copyItems: YES];
 }
 
 /** <override-subclass />
@@ -669,12 +673,16 @@ static SEL	rlSel;
 
 /**
  * Returns an NSMutableArray instance containing the same objects as
- * the receiver.
+ * the receiver.<br />
+ * The default implementation does this by calling the
+ * -initWithArray:copyItems: method on a newly created object,
+ * and passing it NO to tell it just to retain the items.
  */
 - (id) mutableCopyWithZone: (NSZone*)zone
 {
-  return [[GSMutableArrayClass allocWithZone: zone] 
-    initWithArray: self];
+  NSMutableArray	*copy = [NSMutableArrayClass allocWithZone: zone];
+
+  return [copy initWithArray: self copyItems: NO];
 }
 
 /** <override-subclass />
@@ -828,7 +836,7 @@ static int compare(id elem1, id elem2, void* context)
   NSMutableArray	*sortedArray;
 
   sortedArray = [[NSMutableArrayClass allocWithZone:
-    NSDefaultMallocZone()] initWithArray: self];
+    NSDefaultMallocZone()] initWithArray: self copyItems: NO];
   [sortedArray sortUsingFunction: comparator context: context];
 
   return AUTORELEASE([sortedArray makeImmutableCopyOnFail: NO]);
@@ -1108,32 +1116,6 @@ static int compare(id elem1, id elem2, void* context)
   return NSMutableArrayClass;
 }
 
-/* The NSCopying Protocol */
-
-- (id) copyWithZone: (NSZone*)zone
-{
-  /* a deep copy */
-  unsigned	count = [self count];
-  id		objects[count];
-  NSArray	*newArray;
-  unsigned	i;
-
-  [self getObjects: objects];
-  for (i = 0; i < count; i++)
-    {
-      objects[i] = [objects[i] copyWithZone: zone];
-    }
-  newArray = [[GSArrayClass allocWithZone: zone]
-    initWithObjects: objects count: count];
-#if GS_WITH_GC == 0
-  while (i > 0)
-    {
-      [objects[--i] release];
-    }
-#endif
-  return newArray;
-}
-
 /** <init />
  * Initialise the array with the specified capacity ... this
  * should ensure that the array can have numItems added efficiently.

Source/NSDictionary.m

@@ -141,15 +141,31 @@ static SEL	appSel;
   return nil;
 }
 
+/**
+ * Returns a new copy of the receiver.<br />
+ * The default abstract implementation of a copy is to use the
+ * -initWithDictionary:copyItems: method with the flag set to YES.<br />
+ * Immutable subclasses generally simply retain and return the receiver.
+ */
 - (id) copyWithZone: (NSZone*)z
 {
-  return RETAIN(self);
+  NSDictionary	*copy = [NSDictionaryClass allocWithZone: z];
+
+  return [copy initWithDictionary: self copyItems: NO];
 }
 
+/**
+ * Returns a new instance containing the same objects as
+ * the receiver.<br />
+ * The default implementation does this by calling the
+ * -initWithDictionary:copyItems: method on a newly created object,
+ * and passing it NO to tell it just to retain the items.
+ */
 - (id) mutableCopyWithZone: (NSZone*)z
 {
-  return [[GSMutableDictionaryClass allocWithZone: z] 
-	  initWithDictionary: self];
+  NSMutableDictionary	*copy = [NSMutableDictionaryClass allocWithZone: z];
+
+  return [copy initWithDictionary: self copyItems: NO];
 }
 
 - (Class) classForCoder

Source/NSSet.m

@@ -113,9 +113,17 @@ static Class NSMutableSet_concrete_class;
   return NSSet_abstract_class;
 }
 
+/**
+ * Returns a new copy of the receiver.<br />
+ * The default abstract implementation of a copy is to use the
+ * -initWithSet:copyItems: method with the flag set to YES.<br />
+ * Concrete subclasses generally simply retain and return the receiver.
+ */
 - (id) copyWithZone: (NSZone*)z
 {
-  return RETAIN(self);
+  NSSet	*copy = [NSSet_concrete_class allocWithZone: z];
+
+  return [copy initWithSet: self copyItems: YES];
 }
 
 /**
@@ -186,9 +194,18 @@ static Class NSMutableSet_concrete_class;
   return 0;  
 }
 
+/**
+ * Returns a new instance containing the same objects as
+ * the receiver.<br />
+ * The default implementation does this by calling the
+ * -initWithSet:copyItems: method on a newly created object,
+ * and passing it NO to tell it just to retain the items.
+ */
 - (id) mutableCopyWithZone: (NSZone*)z
 {
-  return [[NSMutableSet_concrete_class allocWithZone: z] initWithSet: self];
+  NSMutableSet	*copy = [NSMutableSet_concrete_class allocWithZone: z];
+
+  return [copy initWithSet: self copyItems: NO];
 }
 
 - (NSEnumerator*) objectEnumerator
@@ -493,11 +510,6 @@ static Class NSMutableSet_concrete_class;
   return NSMutableSet_concrete_class;
 }
 
-- (id) copyWithZone: (NSZone*)z
-{
-  return [[NSSet_concrete_class allocWithZone: z] initWithSet: self];
-}
-
 /** <init />
  * Initialises a newly allocated set to contain no objects but
  * to have space available to hold the specified number of items.<br />