/* * Copyright (c) 2014-present, Facebook, Inc. * All rights reserved. * * This source code is licensed under the BSD-style license found in the * LICENSE file in the root directory of this source tree. An additional grant * of patent rights can be found in the PATENTS file in the same directory. * */ #import "ASLayoutSpec.h" #import "ASAssert.h" #import "ASBaseDefines.h" #import "ASEnvironmentInternal.h" #import "ASInternalHelpers.h" #import "ASLayout.h" #import "ASThread.h" #import static NSString * const kDefaultChildKey = @"kDefaultChildKey"; static NSString * const kDefaultChildrenKey = @"kDefaultChildrenKey"; @interface ASLayoutSpec() { ASEnvironmentState _environmentState; ASDN::RecursiveMutex _propertyLock; } @property (nonatomic, strong) NSMutableDictionary *layoutChildren; @end @implementation ASLayoutSpec // these dynamic properties all defined in ASLayoutOptionsPrivate.m @dynamic spacingAfter, spacingBefore, flexGrow, flexShrink, flexBasis, alignSelf, ascender, descender, sizeRange, layoutPosition; @synthesize layoutChildren = _layoutChildren; @synthesize isFinalLayoutable = _isFinalLayoutable; - (instancetype)init { if (!(self = [super init])) { return nil; } _isMutable = YES; _environmentState = ASEnvironmentStateMakeDefault(); return self; } #pragma mark - Layout - (ASLayout *)measureWithSizeRange:(ASSizeRange)constrainedSize { return [ASLayout layoutWithLayoutableObject:self size:constrainedSize.min]; } - (id)finalLayoutable { return self; } - (id)layoutableToAddFromLayoutable:(id)child { if (self.isFinalLayoutable == NO) { // If you are getting recursion crashes here after implementing finalLayoutable, make sure // that you are setting isFinalLayoutable flag to YES. This must be one BEFORE adding a child // to the new ASLayoutable. // // For example: //- (id)finalLayoutable //{ // ASInsetLayoutSpec *insetSpec = [[ASInsetLayoutSpec alloc] init]; // insetSpec.insets = UIEdgeInsetsMake(10,10,10,10); // insetSpec.isFinalLayoutable = YES; // [insetSpec setChild:self]; // return insetSpec; //} id finalLayoutable = [child finalLayoutable]; if (finalLayoutable != child) { // Layout options state of child needs to be copied to final layoutable, but don't override customized values. ASEnvironmentStatePropagateUp(finalLayoutable, child.environmentState.layoutOptionsState); return finalLayoutable; } } return child; } - (NSMutableDictionary *)layoutChildren { if (!_layoutChildren) { _layoutChildren = [NSMutableDictionary dictionary]; } return _layoutChildren; } - (void)setParent:(id)parent { // FIXME: Locking should be evaluated here. _parent is not widely used yet, though. _parent = parent; if ([parent supportsUpwardPropagation]) { ASEnvironmentStatePropagateUp(parent, self.environmentState.layoutOptionsState); } } - (void)setChild:(id)child; { [self setChild:child forIdentifier:kDefaultChildKey]; } - (void)setChild:(id)child forIdentifier:(NSString *)identifier { ASDisplayNodeAssert(self.isMutable, @"Cannot set properties when layout spec is not mutable"); id finalLayoutable = [self layoutableToAddFromLayoutable:child]; self.layoutChildren[identifier] = finalLayoutable; if ([finalLayoutable isKindOfClass:[ASLayoutSpec class]]) { [(ASLayoutSpec *)finalLayoutable setParent:self]; // This will trigger upward propogation if needed. } else if ([self supportsUpwardPropagation]) { ASEnvironmentStatePropagateUp(self, finalLayoutable.environmentState.layoutOptionsState); // Probably an ASDisplayNode } } - (void)setChildren:(NSArray *)children { ASDisplayNodeAssert(self.isMutable, @"Cannot set properties when layout spec is not mutable"); NSMutableArray *finalChildren = [NSMutableArray arrayWithCapacity:children.count]; for (id child in children) { [finalChildren addObject:[self layoutableToAddFromLayoutable:child]]; } self.layoutChildren[kDefaultChildrenKey] = [NSArray arrayWithArray:finalChildren]; } - (id)childForIdentifier:(NSString *)identifier { return self.layoutChildren[identifier]; } - (id)child { return self.layoutChildren[kDefaultChildKey]; } - (NSArray *)children { return self.layoutChildren[kDefaultChildrenKey]; } #pragma mark - ASEnvironment - (ASEnvironmentState)environmentState { return _environmentState; } - (void)setEnvironmentState:(ASEnvironmentState)environmentState { _environmentState = environmentState; } // Subclasses can override this method to return NO, because upward propagation is not enabled if a layout // specification has more than one child. Currently ASStackLayoutSpec and ASStaticLayoutSpec are currently // the specifications that are known to have more than one. - (BOOL)supportsUpwardPropagation { return YES; } ASEnvironmentLayoutOptionsForwarding ASEnvironmentLayoutExtensibilityForwarding @end @implementation ASLayoutSpec (Debugging) #pragma mark - ASLayoutableAsciiArtProtocol + (NSString *)asciiArtStringForChildren:(NSArray *)children parentName:(NSString *)parentName direction:(ASStackLayoutDirection)direction { NSMutableArray *childStrings = [NSMutableArray array]; for (id layoutChild in children) { NSString *childString = [layoutChild asciiArtString]; if (childString) { [childStrings addObject:childString]; } } if (direction == ASStackLayoutDirectionHorizontal) { return [ASAsciiArtBoxCreator horizontalBoxStringForChildren:childStrings parent:parentName]; } return [ASAsciiArtBoxCreator verticalBoxStringForChildren:childStrings parent:parentName]; } + (NSString *)asciiArtStringForChildren:(NSArray *)children parentName:(NSString *)parentName { return [self asciiArtStringForChildren:children parentName:parentName direction:ASStackLayoutDirectionHorizontal]; } - (NSString *)asciiArtString { NSArray *children = self.child ? @[self.child] : self.children; return [ASLayoutSpec asciiArtStringForChildren:children parentName:[self asciiArtName]]; } - (NSString *)asciiArtName { return NSStringFromClass([self class]); } @end