Merge branch 'v3.1' into v3.2

Author: slembcke

UnitTests/CCRendererTests.m

@@ -82,4 +82,22 @@ -(void)testBlendModeDefaults
 	}
 }
 
+-(void)testRenderStateCacheFlush
+{
+	__weak CCRenderState *renderState = nil;
+	
+	@autoreleasepool {
+		CCBlendMode *mode = [CCBlendMode alphaMode];
+		CCShader *shader = [CCShader positionColorShader];
+		CCTexture *texture = [CCTexture textureWithFile:@"Images/grossini_dance_01.png"];
+		
+		renderState = [CCRenderState renderStateWithBlendMode:mode shader:shader mainTexture:texture];
+		XCTAssertNotNil(renderState, @"Render state was not created.");
+	}
+	
+	[CCRENDERSTATE_CACHE flush];
+	
+	XCTAssertNil(renderState, @"Render state was not released.");
+}
+
 @end

UnitTests/CCTextureTests.m

@@ -0,0 +1,57 @@
+#import <XCTest/XCTest.h>
+#import "cocos2d.h"
+
+#import "CCTextureCache.h"
+
+@interface CCTextureTests : XCTestCase
+@end
+
+@implementation CCTextureTests
+
+-(void)testTextureCache
+{
+	__weak CCTexture *textures[4];
+	__weak CCRenderState *renderStates[3];
+	
+	@autoreleasepool {
+		// Load some cached textures
+		for(int i=0; i<4; i++){
+			NSString *name = [NSString stringWithFormat:@"Images/grossini_dance_0%d.png", i + 1];
+			textures[i] = [CCTexture textureWithFile:name];
+		}
+		
+		// Make sure the textures were loaded.
+		for(int i=0; i<4; i++){
+			XCTAssertNotNil(textures[i], @"Texture %d not loaded.", i);
+		}
+		
+		// Create render states for the textures.
+		CCBlendMode *blend = [CCBlendMode premultipliedAlphaMode];
+		CCShader *shader = [CCShader positionColorShader];
+		
+		// A cached render state..
+		renderStates[0] = [CCRenderState renderStateWithBlendMode:blend shader:shader mainTexture:textures[0]];
+		// An uncached, immutable render state.
+		NSDictionary *uniforms1 = @{@"SomeTexture": textures[1]};
+		renderStates[1] = [CCRenderState renderStateWithBlendMode:blend shader:shader shaderUniforms:uniforms1 copyUniforms:YES];
+		// An uncached, mutable render state.
+		NSMutableDictionary *uniforms2 = [NSMutableDictionary dictionaryWithObject:textures[2] forKey:@"SomeTexture"];
+		renderStates[2] = [CCRenderState renderStateWithBlendMode:blend shader:shader shaderUniforms:uniforms2 copyUniforms:NO];
+		// Leave textures[3] unused.
+		
+		// Make sure the render states were loaded
+		for(int i=0; i<3; i++){
+			XCTAssertNotNil(renderStates[i], @"Render state %d not loaded.", i);
+		}
+	}
+	
+	// Flush the texture cache
+	[[CCTextureCache sharedTextureCache] removeUnusedTextures];
+	
+	// Make sure the textures were unloaded.
+	for(int i=0; i<4; i++){
+		XCTAssertNil(textures[i], @"Texture %d still loaded.", i);
+	}
+}
+
+@end

cocos2d-tests-ios.xcodeproj/project.pbxproj

@@ -70,6 +70,7 @@
 		B7EE69CF1819D82300B983FE /* CCLayoutTest.m in Sources */ = {isa = PBXBuildFile; fileRef = B7EE69CE1819D82300B983FE /* CCLayoutTest.m */; };
 		B7EE6A28181B075E00B983FE /* CCSliderTest.m in Sources */ = {isa = PBXBuildFile; fileRef = B7EE6A27181B075E00B983FE /* CCSliderTest.m */; };
 		D2B4894C1917EE6700C3443A /* CCEffectsTest.m in Sources */ = {isa = PBXBuildFile; fileRef = D2B4894B1917EE6700C3443A /* CCEffectsTest.m */; };
+		D32FDE8619B645CA0078CC16 /* CCTextureTests.m in Sources */ = {isa = PBXBuildFile; fileRef = D32FDE8519B645CA0078CC16 /* CCTextureTests.m */; };
 		D3395F1A187F83E600F22C74 /* CCMemoryTests.m in Sources */ = {isa = PBXBuildFile; fileRef = D3395F19187F83E600F22C74 /* CCMemoryTests.m */; settings = {COMPILER_FLAGS = "-fno-objc-arc"; }; };
 		D340E10E185660BE006E605C /* CCPhysicsTest.m in Sources */ = {isa = PBXBuildFile; fileRef = D340E10C185660BE006E605C /* CCPhysicsTest.m */; };
 		D340E10F185660BE006E605C /* TilemapTest.m in Sources */ = {isa = PBXBuildFile; fileRef = D340E10D185660BE006E605C /* TilemapTest.m */; };
@@ -194,6 +195,7 @@
 		B7EE69CE1819D82300B983FE /* CCLayoutTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CCLayoutTest.m; path = "cocos2d-ui-tests/tests/CCLayoutTest.m"; sourceTree = SOURCE_ROOT; };
 		B7EE6A27181B075E00B983FE /* CCSliderTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CCSliderTest.m; path = "cocos2d-ui-tests/tests/CCSliderTest.m"; sourceTree = SOURCE_ROOT; };
 		D2B4894B1917EE6700C3443A /* CCEffectsTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CCEffectsTest.m; path = "cocos2d-ui-tests/tests/CCEffectsTest.m"; sourceTree = SOURCE_ROOT; };
+		D32FDE8519B645CA0078CC16 /* CCTextureTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CCTextureTests.m; sourceTree = "<group>"; };
 		D3395F19187F83E600F22C74 /* CCMemoryTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CCMemoryTests.m; sourceTree = "<group>"; };
 		D340E10C185660BE006E605C /* CCPhysicsTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CCPhysicsTest.m; path = "cocos2d-ui-tests/tests/CCPhysicsTest.m"; sourceTree = SOURCE_ROOT; };
 		D340E10D185660BE006E605C /* TilemapTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = TilemapTest.m; path = "cocos2d-ui-tests/tests/TilemapTest.m"; sourceTree = SOURCE_ROOT; };
@@ -262,6 +264,7 @@
 				D3395F19187F83E600F22C74 /* CCMemoryTests.m */,
 				D34CD3C418ABF4AA00D8E537 /* CCRendererTests.m */,
 				92324E2918EB635500D78D3F /* CCReaderTest.m */,
+				D32FDE8519B645CA0078CC16 /* CCTextureTests.m */,
 				755569EC1856361100ED1B0F /* Supporting Files */,
 			);
 			path = UnitTests;
@@ -636,6 +639,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				92324E2A18EB635500D78D3F /* CCReaderTest.m in Sources */,
+				D32FDE8619B645CA0078CC16 /* CCTextureTests.m in Sources */,
 				75556A161856370A00ED1B0F /* CCFileUtilTests.m in Sources */,
 				92FE241118F5F06F00647961 /* CCAnimationTest.m in Sources */,
 				75556A171856370A00ED1B0F /* CCNodeTests.m in Sources */,

cocos2d/CCEffect.m

@@ -257,7 +257,7 @@ -(void)end
 
 -(void)enqueueTriangles
 {
-    CCRenderState *renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:YES];
+    CCRenderState *renderState = [CCRenderState renderStateWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:YES];
 
     CCRenderBuffer buffer = [_renderer enqueueTriangles:2 andVertexes:4 withState:renderState globalSortOrder:0];
 	CCRenderBufferSetVertex(buffer, 0, CCVertexApplyTransform(_verts.bl, &_transform));

cocos2d/CCNode.h

@@ -108,7 +108,7 @@ A common user pattern in building a Cocos2d game is to subclass CCNode, add it t
 	NSMutableArray *_children;
 
 	// Weak ref to parent.
-	CCNode *__unsafe_unretained _parent;
+	__weak CCNode *_parent;
 
 	// A tag any name you want to assign to the node
     NSString* _name;
@@ -373,7 +373,7 @@ A common user pattern in building a Cocos2d game is to subclass CCNode, add it t
 -(void) removeAllChildrenWithCleanup:(BOOL)cleanup;
 
 /** A weak reference to the parent. */
-@property(nonatomic,readwrite,unsafe_unretained) CCNode* parent;
+@property(nonatomic,readwrite,weak) CCNode* parent;
 
 /** Array of child nodes. */
 @property(nonatomic,readonly) NSArray *children;

cocos2d/CCNode.m

@@ -221,12 +221,6 @@ - (NSString*) description
 - (void) dealloc
 {
 	CCLOGINFO( @"cocos2d: deallocing %@", self);
-
-	// children
-    for (CCNode* child in _children)
-		child.parent = nil;
-
-
 }
 
 #pragma mark Setters
@@ -1725,7 +1719,7 @@ -(CCRenderState *)renderState
 			_shaderUniforms = nil;
 		} else {
 			// Since the node has unique uniforms, it cannot be batched or use the fast path.
-			_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:NO];
+			_renderState = [CCRenderState renderStateWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:NO];
 		}
 	}
 

cocos2d/CCRenderTexture.m

@@ -61,7 +61,7 @@ -(CCRenderState *)renderState
 		BOOL copyUniforms = self.hasDefaultShaderUniforms;
 
 		// Create an uncached renderstate so the texture can be released before the renderstate cache is flushed.
-		_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:self.shaderUniforms copyUniforms:copyUniforms];
+		_renderState = [CCRenderState renderStateWithBlendMode:_blendMode shader:_shader shaderUniforms:self.shaderUniforms copyUniforms:copyUniforms];
 	}
 
 	return _renderState;

cocos2d/CCRenderer.h

@@ -172,12 +172,13 @@ extern const NSString *CCBlendEquationAlpha;
 /// Create a cached blending mode for a given blending mode, shader and main texture.
 +(instancetype)renderStateWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader mainTexture:(CCTexture *)mainTexture;
 
-/// Create an uncached blending mode for a given blending mode, shader and set of uncopied uniform values.
--(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms __deprecated;
-
 /// Create an uncached blending mode for a given blending mode, shader and set of uniform values.
 /// Allowing the uniform dictionary to be copied allows the render state to be immutable and used more optimally.
--(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms;
++(instancetype)renderStateWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms;
+
+/// Initialize an uncached blending mode for a given blending mode, shader and set of uncopied uniform values.
+/// Use [CCRenderState renderStateWithBlendMode:blendMode shader:shader shaderUniforms:shaderUniforms copyUniforms:NO] instead.
+-(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms __deprecated;
 
 @end
 

cocos2d/CCRenderer.m

@@ -277,16 +277,18 @@ +(void)initialize
 
 -(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms
 {
-	return [self initWithBlendMode:blendMode shader:shader shaderUniforms:shaderUniforms copyUniforms:NO];
+	return [self initWithBlendMode:blendMode shader:shader mainTexture:nil shaderUniforms:shaderUniforms copyUniforms:NO];
 }
 
--(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms
+-(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader mainTexture:(CCTexture *)mainTexture shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms
 {
 	if((self = [super init])){
 		_blendMode = blendMode;
 		_shader = shader;
 		_shaderUniforms = (copyUniforms ? [shaderUniforms copy] : shaderUniforms);
 
+		_mainTexture = mainTexture;
+		
 		// The renderstate as a whole is immutable if the uniforms are copied.
 		_immutable = copyUniforms;
 	}
@@ -301,18 +303,24 @@ +(instancetype)renderStateWithBlendMode:(CCBlendMode *)blendMode shader:(CCShade
 		mainTexture = [CCTexture none];
 	}
 
-	CCRenderState *renderState = [[self alloc] initWithBlendMode:blendMode shader:shader shaderUniforms:@{CCShaderUniformMainTexture: mainTexture} copyUniforms:YES];
-	renderState->_mainTexture = mainTexture;
+	// The uniforms are immutable, but don't mark them to be copied.
+	// This forces the cache to create a unique public object for the shared/key values.
+	CCRenderState *renderState = [[self alloc] initWithBlendMode:blendMode shader:shader mainTexture:mainTexture shaderUniforms:@{CCShaderUniformMainTexture: mainTexture} copyUniforms:NO];
 
 	return [CCRENDERSTATE_CACHE objectForKey:renderState];
 }
 
++(instancetype)renderStateWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms
+{
+	return [[self alloc] initWithBlendMode:blendMode shader:shader mainTexture:nil shaderUniforms:shaderUniforms copyUniforms:copyUniforms];
+}
+
 -(id)copyWithZone:(NSZone *)zone
 {
 	if(_immutable){
 		return self;
 	} else {
-		return [[CCRenderState allocWithZone:zone] initWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:YES];
+		return [[CCRenderState allocWithZone:zone] initWithBlendMode:_blendMode shader:_shader mainTexture:_mainTexture shaderUniforms:_shaderUniforms copyUniforms:YES];
 	}
 }