tweak NSCache changes

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

ChangeLog

@@ -1,5 +1,18 @@
+2009-09-01 Richard Frith-Macdonald <rfm@gnu.org>
+
+	* Headers/Foundation/NSCache.h:
+	* Source/NSCache.m:
+	Great additions... tweaked with whitespace changes to conform to
+	coding standards, addition of copyright headers, addition of standard
+	prevention of multiple inclusion, include changes to build independant
+	of any existing installation.
+
 2009-08-31 David Chisnall <csdavec@swan.ac.uk>
 	
+	* Headers/Foundation/NSCache.h:
+	* Headers/Foundation/Foundation.h:
+	* Source/NSCache.m:
+	* Source/GNUmakefile:
 	Added NSCache implementation.
 
 2009-08-31 Richard Frith-Macdonald <rfm@gnu.org>

Headers/Foundation/NSCache.h

@@ -1,13 +1,47 @@
+/* Interface for NSCache for GNUStep
+   Copyright (C) 2009 Free Software Foundation, Inc.
+
+   Written by:  David Chisnall <csdavec@swan.ac.uk>
+   Created: 2009
+   
+   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.
+   */ 
+
+#ifndef __NSCache_h_GNUSTEP_BASE_INCLUDE
+#define __NSCache_h_GNUSTEP_BASE_INCLUDE
+#import	<GNUstepBase/GSVersionMacros.h>
+
 #if OS_API_VERSION(MAC_OS_X_VERSION_10_6, GS_API_LATEST)
 
-#import <Foundation/NSObjCRuntime.h>
+#import <Foundation/NSObject.h>
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
 
 @class NSString;
 @class NSMutableDictionary;
 @class NSMutableArray;
+
 #ifndef __has_feature
 #define __has_feature(x) 0
 #endif
+
 @interface NSCache : NSObject
 {
 #if !__has_feature(objc_nonfragile_abi) || defined(EXPOSE_GSCACHE_IVARS)
@@ -36,62 +70,75 @@
  * Returns the maximum number of objects that are supported by this cache.
  */
 - (NSUInteger) countLimit;
+
 /**
  * Returns the cache's delegate.
  */
 - (id) delegate;
+
 /**
  * Returns whether objects stored in this cache which implement the
  * NSDiscardableContent protocol are removed from the cache when their contents
  * are evicted.
  */
 - (BOOL) evictsObjectsWithDiscardedContent;
+
 /**
  * Returns the name associated with this cache.
  */
 - (NSString*) name;
+
 /**
  * Returns an object associated with the specified key in this cache.
  */
 - (id) objectForKey: (id)key;
+
 /**
  * Removes all objects from this cache.
  */
 - (void) removeAllObjects;
+
 /**
  * Removes the object associated with the given key.
  */
 - (void) removeObjectForKey: (id)key;
+
 /**
  * Sets the maximum number of objects permitted in this cache.  This limit is
  * advisory; caches may choose to disregard it temporarily or permanently.  A
  * limit of 0 is used to indicate no limit; this is the default.
  */
 - (void) setCountLimit: (NSUInteger)lim;;
+
 /**
  * Sets the delegate for this cache.  The delegate will be notified when an
  * object is being evicted or removed from the cache.
  */
 - (void) setDelegate: (id)del;
+
 /**
  * Sets whether this cache will evict objects that conform to the
  * NSDiscardableContent protocol, or simply discard their contents.
  */
 - (void) setEvictsObjectsWithDiscardedContent: (BOOL)b;
+
 /**
  * Sets the name for this cache.
  */
 - (void) setName: (NSString*)cacheName;
+
 /**
  * Adds an object and its associated cost.  The cache will endeavor to keep the
  * total cost below the value set with -setTotalCostLimit: by discarding the
  * contents of objects which implement the NSDiscardableContent protocol.
  */
 - (void) setObject: (id)obj forKey: (id)key cost: (NSUInteger)num;
+
 /**
  * Adds an object to the cache without associating a cost with it.
  */
 - (void) setObject: (id)obj forKey: (id)key;
+
 /**
  * Sets the maximum total cost for objects stored in this cache.  This limit is
  * advisory; caches may choose to disregard it temporarily or permanently.  A
@@ -99,6 +146,7 @@
  */
 - (void) setTotalCostLimit: (NSUInteger)lim;
 @end
+
 /**
  * Protocol implemented by NSCache delegate objects.
  */
@@ -109,4 +157,11 @@
  */
 - (void) cache: (NSCache*)cache willEvictObject: (id)obj;
 @end
+
+#if	defined(__cplusplus)
+}
+#endif
+
 #endif //OS_API_VERSION(MAC_OS_X_VERSION_10_6, GS_API_LATEST)
+
+#endif /* __NSCache_h_GNUSTEP_BASE_INCLUDE */

Source/NSCache.m

@@ -1,5 +1,36 @@
+/* Implementation for NSCache for GNUStep
+   Copyright (C) 2009 Free Software Foundation, Inc.
+
+   Written by:  David Chisnall <csdavec@swan.ac.uk>
+   Created: 2009
+   
+   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 "config.h"
+
 #define EXPOSE_GSCACHE_IVARS 1
-#import <Foundation/Foundation.h>
+
+#import "Foundation/NSArray.h"
+#import "Foundation/NSCache.h"
+#import "Foundation/NSDictionary.h"
+#import "Foundation/NSEnumerator.h"
+#import "Foundation/NSString.h"
 
 /**
  * _GSCachedObject is effectively used as a structure containing the various
@@ -26,30 +57,39 @@
 @implementation NSCache
 - (id) init
 {
-	if (nil == (self = [super init])) { return nil; }
+  if (nil == (self = [super init]))
+    {
+      return nil;
+    }
   _objects = [NSMutableDictionary new];
   _accesses = [NSMutableArray new];
   return self;
 }
+
 - (NSUInteger) countLimit
 {
   return _countLimit;
 }
+
 - (id) delegate
 {
   return _delegate;
 }
+
 - (BOOL) evictsObjectsWithDiscardedContent
 {
   return _evictsObjectsWithDiscardedContent;
 }
+
 - (NSString*) name
 {
   return _name;
 }
+
 - (id) objectForKey: (id)key
 {
   _GSCachedObject *obj = [_objects objectForKey: key];
+
   if (nil == obj)
     {
       return nil;
@@ -64,10 +104,12 @@
   _totalAccesses++;
   return obj->object;
 }
+
 - (void) removeAllObjects
 {
   NSEnumerator *e = [_objects objectEnumerator];
   _GSCachedObject *obj;
+
   while (nil != (obj = [e nextObject]))
     {
       [_delegate cache: self willEvictObject: obj->object];
@@ -76,9 +118,11 @@
   [_accesses removeAllObjects];
   _totalAccesses = 0;
 }
+
 - (void) removeObjectForKey: (id)key
 {
   _GSCachedObject *obj = [_objects objectForKey: key];
+
   if (nil != obj)
     {
       [_delegate cache: self willEvictObject: obj->object];
@@ -87,25 +131,31 @@
       [_accesses removeObjectIdenticalTo: obj];
     }
 }
+
 - (void) setCountLimit: (NSUInteger)lim
 {
   _countLimit = lim;
 }
+
 - (void) setDelegate:(id)del
 {
   _delegate = del;
 }
+
 - (void) setEvictsObjectsWithDiscardedContent:(BOOL)b
 {
   _evictsObjectsWithDiscardedContent = b;
 }
+
 - (void) setName: (NSString*)cacheName
 {
   ASSIGN(_name, cacheName);
 }
+
 - (void) setObject: (id)obj forKey: (id)key cost: (NSUInteger)num
 {
   _GSCachedObject *old = [_objects objectForKey: key];
+
   if (nil != old)
     {
       [self removeObjectForKey: old->key];
@@ -125,18 +175,22 @@
   RELEASE(obj);
   _totalCost += num;
 }
+
 - (void) setObject: (id)obj forKey: (id)key
 {
   [self setObject: obj forKey: key cost: 0];
 }
+
 - (void) setTotalCostLimit: (NSUInteger)lim
 {
   _costLimit = lim;
 }
+
 - (NSUInteger)totalCostLimit
 {
   return _costLimit;
 }
+
 /**
  * This method is the one that handles the eviction policy.  This
  * implementation uses a relatively simple LRU/LFU hybrid.  The NSCache
@@ -176,6 +230,7 @@
 	      if ([obj->object isContentDiscarded])
 		{
 		  NSUInteger cost = obj->cost;
+
 		  // Evicted objects have no cost.
 		  obj->cost = 0;
 		  // Don't try evicting this again in future; it's gone already.
@@ -199,6 +254,7 @@
       if (_evictsObjectsWithDiscardedContent)
 	{
 	  NSString *key;
+
 	  e = [evictedKeys objectEnumerator];
 	  while (nil != (key = [e nextObject]))
 	    {