Merge remote-tracking branch 'upstream/develop' into develop

Author: Thayer J Andrews

cocos2d-tests-ios.xcodeproj/project.pbxproj

@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		0E28FE1A197FCE4500F78989 /* CCCacheTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 0E28FE19197FCE4500F78989 /* CCCacheTest.m */; };
 		75556A04185636F100ED1B0F /* XCTest.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 75556A03185636F100ED1B0F /* XCTest.framework */; };
 		75556A05185636F100ED1B0F /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B7E2605717E7D278007067F0 /* Foundation.framework */; };
 		75556A06185636F100ED1B0F /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B7E2605517E7D278007067F0 /* UIKit.framework */; };
@@ -107,6 +108,7 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		0E28FE19197FCE4500F78989 /* CCCacheTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CCCacheTest.m; path = "cocos2d-ui-tests/tests/CCCacheTest.m"; sourceTree = SOURCE_ROOT; };
 		755569E31856361100ED1B0F /* CCFileUtilTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CCFileUtilTests.m; sourceTree = "<group>"; };
 		755569E41856361100ED1B0F /* CCNodeTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CCNodeTests.m; sourceTree = "<group>"; };
 		755569E51856361100ED1B0F /* CCPhysicsTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CCPhysicsTests.m; sourceTree = "<group>"; };
@@ -354,6 +356,7 @@
 		B71B087F17EA5B500082EBC0 /* Tests */ = {
 			isa = PBXGroup;
 			children = (
+				0E28FE19197FCE4500F78989 /* CCCacheTest.m */,
 				D2B4894B1917EE6700C3443A /* CCEffectsTest.m */,
 				D3D6CF5E18BD5F0500A51531 /* CCRendererTest.m */,
 				D3870C5F18B440150033D885 /* SpritePerformanceTest.m */,
@@ -656,6 +659,7 @@
 				B7EE697918186D5200B983FE /* CCTextFieldTest.m in Sources */,
 				D29698121926DF7500BBB097 /* CCEffectPongTest.m in Sources */,
 				B7E2620017E7D321007067F0 /* AppDelegate.m in Sources */,
+				0E28FE1A197FCE4500F78989 /* CCCacheTest.m in Sources */,
 				B77060AB1832E3310043CC67 /* CCTextureCacheTest.m in Sources */,
 				A664A4EF18A3D9B8006184B8 /* PositioningTest.m in Sources */,
 				B7E2621C17E7D370007067F0 /* main.m in Sources */,

cocos2d-ui-tests/tests/CCCacheTest.m

@@ -0,0 +1,143 @@
+#import "TestBase.h"
+#import "CCCache.h"
+
+// -----------------------------------------------------------------
+// Simple demo cache, holding an allocated array
+// -----------------------------------------------------------------
+
+@interface DemoCache : CCCache @end
+
+@implementation DemoCache
+
+- (id)createSharedDataForKey:(id<NSCopying>)key
+{
+    unsigned char* rawData = malloc(255);
+    CCLOG(@"Data created for key: %@", key);
+    return([NSValue valueWithPointer:rawData]);
+}
+
+- (id)createPublicObjectForSharedData:(id)data
+{
+    return([NSValue valueWithNonretainedObject:data]);
+}
+
+- (void)disposeOfSharedData:(id)data
+{
+    free([((NSValue *)data) pointerValue]);
+}
+
+- (void)logCache
+{
+    for (unsigned char letter = 'A'; letter < 'X'; letter ++)
+    {
+        NSString *key = [NSString stringWithFormat:@"object%c", letter];
+        if ([self keyExists:key])
+        {
+            NSValue *value = [self rawObjectForKey:key];
+            if (value) CCLOG(@"%@", key); else CCLOG(@"%@ (unused)", key);
+        }
+    }
+}
+
+@end
+
+// -----------------------------------------------------------------
+// Cache test
+// -----------------------------------------------------------------
+
+@interface CCCacheTest : TestBase @end
+
+// -----------------------------------------------------------------
+
+@implementation CCCacheTest
+{
+    DemoCache *_cache;
+    int _testStep;
+    NSValue *_A;
+    NSValue *_B;
+}
+
+- (NSArray*) testConstructors
+{
+    return [NSArray arrayWithObjects:
+            @"cacheTest",
+            nil];
+}
+
+- (void)cacheTest
+{
+    self.subTitle = @"Cache Test";
+    
+    CCButton *button = [CCButton buttonWithTitle:@"[ Step test]" fontName:@"Arial" fontSize:18];
+    button.positionType = CCPositionTypeNormalized;
+    button.position = ccp(0.5, 0.5);
+    [button setTarget:self selector:@selector(stepClicked:)];
+    [self.contentNode addChild:button];
+    
+    _testStep = 0;
+    
+    _cache = [DemoCache cache];
+    
+    [_cache preload:@"objectA"];
+    [_cache preload:@"objectA"]; // same object as above
+    [_cache preload:@"objectB"];
+    [_cache preload:@"objectC"];
+}
+
+- (void)stepClicked:(id)sender
+{
+    CCLOG(@"---------------------------------------------------");
+    switch (_testStep) {
+        case 0:
+            CCLOG(@"-- All cached objects should be unused");
+            break;
+            
+        case 1:
+            CCLOG(@"-- objectA in use");
+            _A = [_cache objectForKey:@"objectA"];
+            break;
+            
+        case 2:
+            CCLOG(@"-- objectB in use");
+            _B = [_cache objectForKey:@"objectB"];
+            break;
+            
+        case 3:
+            CCLOG(@"-- Flush, and thus remove objectC");
+            [_cache flush];
+            break;
+            
+        case 4:
+            CCLOG(@"-- objectA not in use anymore");
+            _A = nil;
+            break;
+            
+        case 5:
+            CCLOG(@"-- Flush, and thus only leaving objectB");
+            [_cache flush];
+            break;
+            
+        case 6:
+            CCLOG(@"-- New objectA should be created");
+            _A = [_cache objectForKey:@"objectA"];
+            break;
+            
+        case 7:
+            CCLOG(@"-- No new objectB should be created");
+            [_cache flush];
+            _B = [_cache objectForKey:@"objectB"];
+            break;
+            
+        default:
+            CCLOG(@"End of test!");
+            _testStep = -1;
+            break;
+    }
+    [_cache logCache];
+    _testStep ++;
+}
+
+
+// -----------------------------------------------------------------
+
+@end

cocos2d/CCCache.h

@@ -45,6 +45,7 @@
 - (instancetype)init;
 
 - (void)preload:(id<NSCopying>)key;
+- (BOOL)keyExists:(id<NSCopying>)key;
 
 - (id)rawObjectForKey:(id<NSCopying>)key;
 - (id)objectForKey:(id<NSCopying>)key;

cocos2d/CCCache.m

@@ -84,28 +84,28 @@ - (CCCacheEntry *)entryForKey:(id<NSCopying>)key
     CCCacheEntry *entry = [_cacheList objectForKey:key];
 
     if (entry == nil)
-		{
-				// Create the cached entry with the shared data.
+    {
+        // Create the cached entry with the shared data.
         entry = [[CCCacheEntry alloc] init];
-				entry.sharedData = [self createSharedDataForKey:key];
-				
+        entry.sharedData = [self createSharedDataForKey:key];
+        
         [_cacheList setObject:entry forKey:key];
     }
-		
-		return entry;
+    
+    return entry;
 }
 
 - (id)objectForKey:(id<NSCopying>)key
 {
     CCCacheEntry *entry = [self entryForKey:key];
 
-		id object = entry.publicObject;
-		if (object == nil)
-		{
+    id object = entry.publicObject;
+    if (object == nil)
+    {
         // Create the public object from the shared data.
-		    object = entry.publicObject = [self createPublicObjectForSharedData:entry.sharedData];
-		}
-		
+        object = entry.publicObject = [self createPublicObjectForSharedData:entry.sharedData];
+    }
+    
     return object;
 }
 
@@ -115,6 +115,11 @@ - (void)makeAlias:(id<NSCopying>)alias forKey:(id<NSCopying>)key
 		[_cacheList setObject:entry forKey:alias];
 }
 
+- (BOOL)keyExists:(id<NSCopying>)key
+{
+    return([_cacheList objectForKey:key] != nil);
+}
+
 //------------------------------------------------------------------------------
 
 - (void)flush

cocos2d/CCNode.h

@@ -393,28 +393,6 @@ A common user pattern in building a Cocos2d game is to subclass CCNode, add it t
 /** The z order of the node relative to its "siblings": children of the same parent. */
 @property(nonatomic,assign) NSInteger zOrder;
 
-
-/// -----------------------------------------------------------------------
-/// @name Hit tests
-/// -----------------------------------------------------------------------
-
-/**
- *  Check if a touch is inside the node.
- *  To allow for custom detection, override this method.
- *
- *  @param pos World position.
- *
- *  @return Returns true, if the position is inside the node.
- */
-- (BOOL)hitTestWithWorldPos:(CGPoint)pos;
-
-/** 
- *  Expands ( or contracts ) the hit area of the node.
- *  The expansion is calculated as a margin around the sprite, in points.
- */
-@property (nonatomic, assign) float hitAreaExpansion;
-
-
 /// -----------------------------------------------------------------------
 /// @name Scene Management
 /// -----------------------------------------------------------------------

cocos2d/CCNode.m

@@ -1618,7 +1618,7 @@ - (CGPoint)convertToWindowSpace:(CGPoint)nodePoint
 - (BOOL)hitTestWithWorldPos:(CGPoint)pos
 {
     pos = [self convertToNodeSpace:pos];
-    CGPoint offset = ccp(-_hitAreaExpansion, -_hitAreaExpansion);
+    CGPoint offset = ccp(-self.hitAreaExpansion, -self.hitAreaExpansion);
     CGSize size = CGSizeMake(self.contentSizeInPoints.width - offset.x, self.contentSizeInPoints.height - offset.y);
     if ((pos.y < offset.y) || (pos.y > size.height) || (pos.x < offset.x) || (pos.x > size.width)) return(NO);
 
@@ -1627,7 +1627,6 @@ - (BOOL)hitTestWithWorldPos:(CGPoint)pos
 
 // -----------------------------------------------------------------
 
-
 #pragma mark - CCColor methods
 
 @synthesize cascadeColorEnabled=_cascadeColorEnabled;

cocos2d/CCResponder.h

@@ -40,6 +40,9 @@
  */
 @interface CCResponder : NSObject
 
+/// -----------------------------------------------------------------------
+/// @name Basic responder control
+/// -----------------------------------------------------------------------
 
 /** Enables user interaction on a node. */
 @property ( nonatomic, assign, getter = isUserInteractionEnabled ) BOOL userInteractionEnabled;
@@ -61,6 +64,12 @@
  */
 @property (nonatomic, assign, getter = isExclusiveTouch) BOOL exclusiveTouch;
 
+/**
+ *  Expands ( or contracts ) the hit area of the node.
+ *  The expansion is calculated as a margin around the sprite, in points.
+ */
+@property (nonatomic, assign) float hitAreaExpansion;
+
 /// -----------------------------------------------------------------------
 /// @name Initializing a CCResponder Object
 /// -----------------------------------------------------------------------
@@ -72,8 +81,21 @@
  */
 - (id)init;
 
-#if ( TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR )
+/// -----------------------------------------------------------------------
+/// @name Hit tests
+/// -----------------------------------------------------------------------
 
+/**
+ *  Check if a touch is inside the node.
+ *  To allow for custom detection, override this method.
+ *
+ *  @param pos World position.
+ *
+ *  @return Returns true, if the position is inside the node.
+ */
+- (BOOL)hitTestWithWorldPos:(CGPoint)pos;
+
+#if ( TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR )
 
 #pragma mark -
 #pragma mark Touch Handling Methods

cocos2d/CCResponder.m

@@ -64,6 +64,14 @@ - (void)setUserInteractionEnabled:(BOOL)userInteractionEnabled
     [[[CCDirector sharedDirector] responderManager] markAsDirty];
 }
 
+// -----------------------------------------------------------------
+// override for touch and mouse functionality
+
+- (BOOL)hitTestWithWorldPos:(CGPoint)pos
+{
+    return(NO);
+}
+
 // -----------------------------------------------------------------
 #pragma mark - iOS
 // -----------------------------------------------------------------