Skip to content

Commit 1103f82

Browse files
secretiverhymesecretiverhyme
committed
.preventOrCancelDisplay -> .displaySuspended.
Rename the ASDisplayNode property to match its _ASDisplayLayer counterpart -- `displaySuspended` is more succinct and is a more plausible name for a Cocoa BOOL property.
1 parent 51f3073 commit 1103f82

7 files changed

Lines changed: 29 additions & 29 deletions

File tree

‎AsyncDisplayKit/ASDisplayNode.h‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -319,31 +319,31 @@
319319
* progress.
320320
*
321321
* Defaults to NO. Does not control display for any child or descendant nodes; for that, use
322-
* -recursiveSetPreventOrCancelDisplay:.
322+
* -recursivelySetDisplaySuspended:.
323323
*
324-
* If a setNeedsDisplay occurs while preventOrCancelDisplay is YES, and preventOrCancelDisplay is set to NO, then the
324+
* If a setNeedsDisplay occurs while displaySuspended is YES, and displaySuspended is set to NO, then the
325325
* layer will be automatically displayed.
326326
*/
327-
@property (nonatomic, assign) BOOL preventOrCancelDisplay;
327+
@property (nonatomic, assign) BOOL displaySuspended;
328328

329329
/**
330330
* @abstract Prevent the node and its descendants' layer from displaying.
331331
*
332332
* @param flag YES if display should be prevented or cancelled; NO otherwise.
333333
*
334-
* @see preventOrCancelDisplay
334+
* @see displaySuspended
335335
*/
336-
- (void)recursiveSetPreventOrCancelDisplay:(BOOL)flag;
336+
- (void)recursivelySetDisplaySuspended:(BOOL)flag;
337337

338338
/**
339339
* @abstract Calls -reclaimMemory on the receiver and its subnode hierarchy.
340340
*
341341
* @discussion Clears backing stores and other memory-intensive intermediates.
342342
* If the node is removed from a visible hierarchy and then re-added, it will automatically trigger a new asynchronous display,
343-
* as long as preventOrCancelDisplay is not set.
343+
* as long as displaySuspended is not set.
344344
* If the node remains in the hierarchy throughout, -setNeedsDisplay is required to trigger a new asynchronous display.
345345
*
346-
* @see preventOrCancelDisplay and setNeedsDisplay
346+
* @see displaySuspended and setNeedsDisplay
347347
*/
348348

349349
- (void)recursivelyReclaimMemory;

‎AsyncDisplayKit/ASDisplayNode.mm‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1326,7 +1326,7 @@ - (void)_applyPendingStateToViewOrLayer
13261326
_pendingViewState = nil;
13271327

13281328
// TODO: move this into real pending state
1329-
if (_flags.preventOrCancelDisplay) {
1329+
if (_flags.displaySuspended) {
13301330
self.asyncLayer.displaySuspended = YES;
13311331
}
13321332
if (!_flags.displaysAsynchronously) {
@@ -1359,12 +1359,12 @@ - (ASDisplayNode *)_supernodeWithClass:(Class)supernodeClass
13591359
return nil;
13601360
}
13611361

1362-
- (void)recursiveSetPreventOrCancelDisplay:(BOOL)flag
1362+
- (void)recursivelySetDisplaySuspended:(BOOL)flag
13631363
{
1364-
_recursiveSetPreventOrCancelDisplay(self, nil, flag);
1364+
_recursivelySetDisplaySuspended(self, nil, flag);
13651365
}
13661366

1367-
static void _recursiveSetPreventOrCancelDisplay(ASDisplayNode *node, CALayer *layer, BOOL flag)
1367+
static void _recursivelySetDisplaySuspended(ASDisplayNode *node, CALayer *layer, BOOL flag)
13681368
{
13691369
// If there is no layer, but node whose its view is loaded, then we can traverse down its layer hierarchy. Otherwise we must stick to the node hierarchy to avoid loading views prematurely. Note that for nodes that haven't loaded their views, they can't possibly have subviews/sublayers, so we don't need to traverse the layer hierarchy for them.
13701370
if (!layer && node && node.nodeLoaded) {
@@ -1377,29 +1377,29 @@ static void _recursiveSetPreventOrCancelDisplay(ASDisplayNode *node, CALayer *la
13771377
}
13781378

13791379
// Set the flag on the node. If this is a pure layer (no node) then this has no effect (plain layers don't support preventing/cancelling display).
1380-
node.preventOrCancelDisplay = flag;
1380+
node.displaySuspended = flag;
13811381

13821382
if (layer && !node.shouldRasterizeDescendants) {
13831383
// If there is a layer, recurse down the layer hierarchy to set the flag on descendants. This will cover both layer-based and node-based children.
13841384
for (CALayer *sublayer in layer.sublayers) {
1385-
_recursiveSetPreventOrCancelDisplay(nil, sublayer, flag);
1385+
_recursivelySetDisplaySuspended(nil, sublayer, flag);
13861386
}
13871387
} else {
13881388
// If there is no layer (view not loaded yet) or this node rasterizes descendants (there won't be a layer tree to traverse), recurse down the subnode hierarchy to set the flag on descendants. This covers only node-based children, but for a node whose view is not loaded it can't possibly have nodeless children.
13891389
for (ASDisplayNode *subnode in node.subnodes) {
1390-
_recursiveSetPreventOrCancelDisplay(subnode, nil, flag);
1390+
_recursivelySetDisplaySuspended(subnode, nil, flag);
13911391
}
13921392
}
13931393
}
13941394

1395-
- (BOOL)preventOrCancelDisplay
1395+
- (BOOL)displaySuspended
13961396
{
13971397
ASDisplayNodeAssertThreadAffinity(self);
13981398
ASDN::MutexLocker l(_propertyLock);
1399-
return _flags.preventOrCancelDisplay;
1399+
return _flags.displaySuspended;
14001400
}
14011401

1402-
- (void)setPreventOrCancelDisplay:(BOOL)flag
1402+
- (void)setDisplaySuspended:(BOOL)flag
14031403
{
14041404
ASDisplayNodeAssertThreadAffinity(self);
14051405

@@ -1409,10 +1409,10 @@ - (void)setPreventOrCancelDisplay:(BOOL)flag
14091409

14101410
ASDN::MutexLocker l(_propertyLock);
14111411

1412-
if (_flags.preventOrCancelDisplay == flag)
1412+
if (_flags.displaySuspended == flag)
14131413
return;
14141414

1415-
_flags.preventOrCancelDisplay = flag;
1415+
_flags.displaySuspended = flag;
14161416

14171417
self.asyncLayer.displaySuspended = flag;
14181418
}

‎AsyncDisplayKit/ASImageNode.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ typedef UIImage *(^asimagenode_modification_block_t)(UIImage *image);
107107
*
108108
* @param displayCompletionBlock The block to be performed after display has
109109
* finished. Its `canceled` property will be YES if display was prevented or
110-
* canceled (via preventOrCancelDisplay); NO otherwise.
110+
* canceled (via displaySuspended); NO otherwise.
111111
*
112112
* @discussion displayCompletionBlock will be performed on the main-thread. If
113-
* `preventOrCancelDisplay` is YES, `displayCompletionBlock` is will be
113+
* `displaySuspended` is YES, `displayCompletionBlock` is will be
114114
* performed immediately and `YES` will be passed for `canceled`.
115115
*/
116116
- (void)setNeedsDisplayWithCompletion:(void (^)(BOOL canceled))displayCompletionBlock;

‎AsyncDisplayKit/ASImageNode.mm‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ - (void)displayDidFinish
263263
#pragma mark -
264264
- (void)setNeedsDisplayWithCompletion:(void (^)(BOOL canceled))displayCompletionBlock
265265
{
266-
if (self.preventOrCancelDisplay) {
266+
if (self.displaySuspended) {
267267
if (displayCompletionBlock)
268268
displayCompletionBlock(YES);
269269
return;

‎AsyncDisplayKit/Details/ASRangeController.mm‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ - (void)removeNodeFromWorkingRange:(ASCellNode *)node
187187
ASDisplayNodeAssertMainThread();
188188
ASDisplayNodeAssert(node, @"invalid argument");
189189

190-
[node recursiveSetPreventOrCancelDisplay:YES];
190+
[node recursivelySetDisplaySuspended:YES];
191191
[node.view removeFromSuperview];
192192

193193
// since this class usually manages large or infinite data sets, the working range
@@ -526,7 +526,7 @@ - (ASCellNode *)sizedNodeForIndexPath:(NSIndexPath *)indexPath
526526
ASCellNode *sizedNode = _nodes[[NSIndexPath indexPathForRow:indexPath.row inSection:indexPath.section]];
527527
ASDisplayNodeAssert(sizedNode, @"this node should be sized but doesn't even exist");
528528
ASDisplayNodeAssert([sizedNode.asyncdisplaykit_indexPath isEqual:indexPath], @"this node has the wrong index path");
529-
[sizedNode recursiveSetPreventOrCancelDisplay:NO];
529+
[sizedNode recursivelySetDisplaySuspended:NO];
530530
return sizedNode;
531531
}
532532

‎AsyncDisplayKit/Private/ASDisplayNodeInternal.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ void ASDisplayNodePerformBlockOnMainThread(void (^block)());
6161
unsigned layerBacked:1;
6262
unsigned displaysAsynchronously:1;
6363
unsigned shouldRasterizeDescendants:1;
64-
unsigned preventOrCancelDisplay:1;
64+
unsigned displaySuspended:1;
6565

6666
// whether custom drawing is enabled
6767
unsigned implementsDrawRect:1;

‎AsyncDisplayKitTests/ASDisplayNodeTests.m‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ - (void)checkValuesMatchDefaults:(ASDisplayNode *)node isLayerBacked:(BOOL)isLay
149149
XCTAssertEqual(3.f, node.shadowRadius, @"default shadowRadius broken %@", hasLoadedView);
150150
XCTAssertEqual(0.0f, node.borderWidth, @"default borderWidth broken %@", hasLoadedView);
151151
XCTAssertEqualObjects(rgbBlackCGColorIdPtr, (id)node.borderColor, @"default borderColor broken %@", hasLoadedView);
152-
XCTAssertEqual(NO, node.preventOrCancelDisplay, @"default preventOrCancelDisplay broken %@", hasLoadedView);
152+
XCTAssertEqual(NO, node.displaySuspended, @"default displaySuspended broken %@", hasLoadedView);
153153
XCTAssertEqual(YES, node.displaysAsynchronously, @"default displaysAsynchronously broken %@", hasLoadedView);
154154
XCTAssertEqual(NO, node.asyncdisplaykit_asyncTransactionContainer, @"default asyncdisplaykit_asyncTransactionContainer broken %@", hasLoadedView);
155155
XCTAssertEqualObjects(nil, node.name, @"default name broken %@", hasLoadedView);
@@ -245,8 +245,8 @@ - (void)checkValuesMatchSetValues:(ASDisplayNode *)node isLayerBacked:(BOOL)isLa
245245
XCTAssertEqual(.5f, node.shadowRadius, @"shadowRadius broken %@", hasLoadedView);
246246
XCTAssertEqual(.5f, node.borderWidth, @"borderWidth broken %@", hasLoadedView);
247247
XCTAssertEqual([[UIColor orangeColor] CGColor], node.borderColor, @"borderColor broken %@", hasLoadedView);
248-
XCTAssertEqual(YES, node.preventOrCancelDisplay, @"preventOrCancelDisplay broken %@", hasLoadedView);
249-
XCTAssertEqual(NO, node.displaysAsynchronously, @"preventOrCancelDisplay broken %@", hasLoadedView);
248+
XCTAssertEqual(YES, node.displaySuspended, @"displaySuspended broken %@", hasLoadedView);
249+
XCTAssertEqual(NO, node.displaysAsynchronously, @"displaySuspended broken %@", hasLoadedView);
250250
XCTAssertEqual(YES, node.asyncdisplaykit_asyncTransactionContainer, @"asyncTransactionContainer broken %@", hasLoadedView);
251251
XCTAssertEqual(NO, node.userInteractionEnabled, @"userInteractionEnabled broken %@", hasLoadedView);
252252
XCTAssertEqual((BOOL)!isLayerBacked, node.exclusiveTouch, @"exclusiveTouch broken %@", hasLoadedView);
@@ -298,7 +298,7 @@ - (void)checkSimpleBridgePropertiesSetPropagate:(BOOL)isLayerBacked
298298
node.shadowRadius = .5f;
299299
node.borderWidth = .5f;
300300
node.borderColor = [[UIColor orangeColor] CGColor];
301-
node.preventOrCancelDisplay = YES;
301+
node.displaySuspended = YES;
302302
node.displaysAsynchronously = NO;
303303
node.asyncdisplaykit_asyncTransactionContainer = YES;
304304
node.userInteractionEnabled = NO;

0 commit comments

Comments
 (0)