libs-base/Source/GSOrderedSet.m

/** Concrete implementation of GSOrderedSet based on GNU Set class
    Copyright (C) 2019 Free Software Foundation, Inc.
    
    Written by: Gregory Casamento <greg.casamento@gmail.com>
    Created: May 17 2019
    
    This file is part of the GNUstep Base Library.
    
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    _version 2 of the License, or (at your option) any later _version.
    
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
    
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02111 USA.
*/

#import "common.h"
#import "Foundation/NSOrderedSet.h"
#import "Foundation/NSAutoreleasePool.h"
#import "Foundation/NSArray.h"
#import "Foundation/NSEnumerator.h"
#import "Foundation/NSException.h"
#import "Foundation/NSPortCoder.h"
#import "Foundation/NSIndexSet.h"
#import "Foundation/NSKeyedArchiver.h"
#import "GNUstepBase/GSObjCRuntime.h"
#import "GSPrivate.h"
#import "GSFastEnumeration.h"
#import "GSDispatch.h"
#import "GSSorting.h"

#define	GSI_ARRAY_TYPE	NSRange
#define	GSI_ARRAY_NO_RELEASE	1
#define	GSI_ARRAY_NO_RETAIN	1
#define GSI_ARRAY_TYPES       GSUNION_OBJ

#define GSI_ARRAY_RELEASE(A, X)	[(X).obj release]
#define GSI_ARRAY_RETAIN(A, X)	[(X).obj retain]

#import "GNUstepBase/GSIArray.h"

//  static SEL     memberSel;
static SEL      privateCountOfSel;
@interface GSOrderedSet : NSOrderedSet
{
@public
  GSIArray_t array;
}
@end

@interface GSMutableOrderedSet : NSMutableOrderedSet
{
@public
  GSIArray_t array;
@private
  NSUInteger _version;
}
@end

@interface GSOrderedSetEnumerator : NSEnumerator
{
  GSOrderedSet *set;
  unsigned      current;
  unsigned      count;
}
@end

@implementation GSOrderedSetEnumerator
- (id) initWithOrderedSet: (NSOrderedSet*)d
{
  self = [super init];
  if (self != nil)
    {
      set = (GSOrderedSet*)RETAIN(d);
      current = 0;
      count = GSIArrayCount(&set->array);
    }
  return self;
}

- (id) nextObject
{
  if(current < count)
    {
      GSIArrayItem item = GSIArrayItemAtIndex(&set->array, current);
      current++;
      return (id)(item.obj);
    }
  return nil;
}

- (void) dealloc
{
  RELEASE(set);
  [super dealloc];
}
@end

@implementation GSOrderedSet

static Class	setClass;
static Class	mutableSetClass;

+ (void) initialize
{
  if (self == [GSOrderedSet class])
    {
      setClass = [GSOrderedSet class];
      mutableSetClass = [GSMutableOrderedSet class];
      privateCountOfSel = @selector(_countForObject:);
    }
}

- (id) copyWithZone: (NSZone*)z
{
  return RETAIN(self);
}

- (void) dealloc
{
  GSIArrayEmpty(&array);
  [super dealloc];
}

- (NSUInteger) hash
{
  return [self count];
}

- (id) init
{
  return [self initWithObjects: 0 count: 0];
}

- (NSEnumerator*) objectEnumerator
{
  return AUTORELEASE([[GSOrderedSetEnumerator alloc] initWithOrderedSet: self]);
}

- (NSUInteger) countByEnumeratingWithState: (NSFastEnumerationState*)state
                                   objects: (id*)stackbuf
                                     count: (NSUInteger)len
{
  //state->mutationsPtr = (unsigned long *)self;
  //return GSIMapCountByEnumeratingWithStateObjectsCount
  //            (&map, state, stackbuf, len);

  return [self count];
}

- (NSUInteger) sizeInBytesExcluding: (NSHashTable*)exclude
{
  NSUInteger	size = GSPrivateMemorySize(self, exclude);

  if (size > 0)
    {
      NSUInteger count = [self count];
      NSUInteger i = 0;

      for(i = 0; i < count; i++)
	{
	  GSIArrayItem item = GSIArrayItemAtIndex(&array, i);
          size += [item.obj sizeInBytesExcluding: exclude];
        }
    }
  return size;
}

// Put required overrides here...
- (NSUInteger) count
{
  return GSIArrayCount(&array);
}

- (id) objectAtIndex: (NSUInteger)index
{
  GSIArrayItem item = GSIArrayItemAtIndex(&array, index);
  return item.obj;
}

- (id) objectAtIndexedSubscript: (NSUInteger)index
{
  return[self objectAtIndex: index];
}

- (BOOL) containsObject: (id)anObject
{
  NSUInteger i = 0;

  for (i = 0; i < [self count]; i++)
    {
      id obj = [self objectAtIndex: i];
      if([anObject isEqual: obj])
	{
	  return YES;
	}
    }
  
  return NO;
}

/* Designated initialiser */
- (id) initWithObjects: (const id*)objs count: (NSUInteger)c
{
  NSUInteger i = 0;

  // Reduce C if it doesn't match.  This is apparently how
  // macOS behaves.
  if(c > sizeof(objs))
    {
      c = sizeof(objs);
    }

  // Initialize and fill the set.
  GSIArrayInitWithZoneAndCapacity(&array, [self zone], c);
  for (i = 0; i < c; i++)
    {
      id obj = objs[i];
      GSIArrayItem item;
      
      if (objs[i] == nil)
	{
	  DESTROY(self);
	  [NSException raise: NSInvalidArgumentException
		      format: @"Tried to init set with nil value"];
	}

      item.obj = obj;
      if(![self containsObject: obj])
	{
	  GSIArrayAddItem(&array, item);
	  RETAIN(obj);
	}
    }
  return self;
}

- (id) initWithObject: (id)obj
{
  id objs[] = {obj};
  
  self = [self initWithObjects: objs count: 1];
  if(self == nil)
    {
      NSLog(@"Problem initializing with one element");
    }
  return self;
}
@end

@implementation GSMutableOrderedSet

+ (void) initialize
{
  if (self == [GSMutableOrderedSet class])
    {
      GSObjCAddClassBehavior(self, [GSOrderedSet class]);
    }
}

- (void) addObject: (id)anObject
{
  GSIArrayItem item;

  if (anObject == nil)
    {
      [NSException raise: NSInvalidArgumentException
		  format: @"Tried to add nil to set"];
    }

  if([self containsObject: anObject] == NO)
    {
      item.obj = anObject;
      GSIArrayAddItem(&array, item);
      RETAIN(anObject);
      _version++;
    }
}

- (void) insertObject: (id)object atIndex: (NSUInteger)index
{
  GSIArrayItem item;
  item.obj = object;
  GSIArrayInsertItem(&array, item, index);
}

- (void) removeObjectAtIndex: (NSUInteger)index
{
  GSIArrayRemoveItemAtIndex(&array, index);
}

- (void) replaceObjectAtIndex: (NSUInteger)index
		   withObject: (id)obj
{
  [self removeObjectAtIndex: index];
  [self insertObject: obj atIndex: index];
}

- (id) init
{
  return [self initWithCapacity: 0];
}

/* Designated initialiser */
- (id) initWithCapacity: (NSUInteger)cap
{
  GSIArrayInitWithZoneAndCapacity(&array, [self zone], cap);
  return self;
}

- (id) initWithObjects: (const id*)objects
		 count: (NSUInteger)count
{
  NSUInteger i = 0;

  // Reduce count if more then size of list of objects
  if(sizeof(objects) < count)
    {
      count = sizeof(objects);
    }

  // Init and fill set
  self = [self initWithCapacity: count];
  if(self != nil)
    {
      for(i = 0; i < count; i++)
	{
	  id	anObject = objects[i];
	  
	  if (anObject == nil)
	    {
	      NSLog(@"Tried to init an orderedset with a nil object");
	      continue;
	    }
	  else
	    {
	      GSIArrayItem item;
	      if(![self containsObject: anObject])
		{
		  item.obj = anObject;
		  GSIArrayAddItem(&array, item);
		  RETAIN(anObject);
		}
	    }
	}
    }
  return self;
}

- (BOOL) makeImmutable
{
  GSClassSwizzle(self, [GSOrderedSet class]);
  return YES;
}

- (id) makeImmutableCopyOnFail: (BOOL)force
{
  GSClassSwizzle(self, [GSOrderedSet class]);
  return self;
}

- (NSUInteger) countByEnumeratingWithState: (NSFastEnumerationState*)state
                                   objects: (id*)stackbuf
                                     count: (NSUInteger)len
{
  //state->mutationsPtr = (unsigned long *)&_version;
  //return GSIMapCountByEnumeratingWithStateObjectsCount
  //  (&map, state, stackbuf, len);
  return [self count];
}
@end

@interface	NSGOrderedSet : NSOrderedSet
@end

@implementation	NSGOrderedSet
- (id) initWithCoder: (NSCoder*)aCoder
{
  NSLog(@"Warning - decoding archive containing obsolete %@ object - please delete/replace this archive", NSStringFromClass([self class]));
  DESTROY(self);
  self = (id)NSAllocateObject([GSOrderedSet class], 0, NSDefaultMallocZone());
  self = [self initWithCoder: aCoder];
  return self;
}
@end

@interface	NSGMutableOrderedSet : NSMutableOrderedSet
@end
@implementation	NSGMutableOrderedSet
- (id) initWithCoder: (NSCoder*)aCoder
{
  NSLog(@"Warning - decoding archive containing obsolete %@ object - please delete/replace this archive", NSStringFromClass([self class]));
  DESTROY(self);
  self = (id)NSAllocateObject([GSMutableOrderedSet class], 0, NSDefaultMallocZone());
  self = [self initWithCoder: aCoder];
  return self;
}
@end