MASViewConstraint.m 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397
  1. //
  2. // MASConstraint.m
  3. // Masonry
  4. //
  5. // Created by Jonas Budelmann on 20/07/13.
  6. // Copyright (c) 2013 cloudling. All rights reserved.
  7. //
  8. #import "MASViewConstraint.h"
  9. #import "MASConstraint+Private.h"
  10. #import "MASCompositeConstraint.h"
  11. #import "MASLayoutConstraint.h"
  12. #import "View+MASAdditions.h"
  13. #import <objc/runtime.h>
  14. @interface MAS_VIEW (MASConstraints)
  15. @property (nonatomic, readonly) NSMutableSet *mas_installedConstraints;
  16. @end
  17. @implementation MAS_VIEW (MASConstraints)
  18. static char kInstalledConstraintsKey;
  19. - (NSMutableSet *)mas_installedConstraints {
  20. NSMutableSet *constraints = objc_getAssociatedObject(self, &kInstalledConstraintsKey);
  21. if (!constraints) {
  22. constraints = [NSMutableSet set];
  23. objc_setAssociatedObject(self, &kInstalledConstraintsKey, constraints, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
  24. }
  25. return constraints;
  26. }
  27. @end
  28. @interface MASViewConstraint ()
  29. @property (nonatomic, strong, readwrite) MASViewAttribute *secondViewAttribute;
  30. @property (nonatomic, weak) MAS_VIEW *installedView;
  31. @property (nonatomic, weak) MASLayoutConstraint *layoutConstraint;
  32. @property (nonatomic, assign) NSLayoutRelation layoutRelation;
  33. @property (nonatomic, assign) MASLayoutPriority layoutPriority;
  34. @property (nonatomic, assign) CGFloat layoutMultiplier;
  35. @property (nonatomic, assign) CGFloat layoutConstant;
  36. @property (nonatomic, assign) BOOL hasLayoutRelation;
  37. @property (nonatomic, strong) id mas_key;
  38. @property (nonatomic, assign) BOOL useAnimator;
  39. @end
  40. @implementation MASViewConstraint
  41. - (id)initWithFirstViewAttribute:(MASViewAttribute *)firstViewAttribute {
  42. self = [super init];
  43. if (!self) return nil;
  44. _firstViewAttribute = firstViewAttribute;
  45. self.layoutPriority = MASLayoutPriorityRequired;
  46. self.layoutMultiplier = 1;
  47. return self;
  48. }
  49. #pragma mark - NSCoping
  50. - (id)copyWithZone:(NSZone __unused *)zone {
  51. MASViewConstraint *constraint = [[MASViewConstraint alloc] initWithFirstViewAttribute:self.firstViewAttribute];
  52. constraint.layoutConstant = self.layoutConstant;
  53. constraint.layoutRelation = self.layoutRelation;
  54. constraint.layoutPriority = self.layoutPriority;
  55. constraint.layoutMultiplier = self.layoutMultiplier;
  56. constraint.delegate = self.delegate;
  57. return constraint;
  58. }
  59. #pragma mark - Public
  60. + (NSArray *)installedConstraintsForView:(MAS_VIEW *)view {
  61. return [view.mas_installedConstraints allObjects];
  62. }
  63. #pragma mark - Private
  64. - (void)setLayoutConstant:(CGFloat)layoutConstant {
  65. _layoutConstant = layoutConstant;
  66. #if TARGET_OS_MAC && !TARGET_OS_IPHONE
  67. if (self.useAnimator) {
  68. [self.layoutConstraint.animator setConstant:layoutConstant];
  69. } else {
  70. self.layoutConstraint.constant = layoutConstant;
  71. }
  72. #else
  73. self.layoutConstraint.constant = layoutConstant;
  74. #endif
  75. }
  76. - (void)setLayoutRelation:(NSLayoutRelation)layoutRelation {
  77. _layoutRelation = layoutRelation;
  78. self.hasLayoutRelation = YES;
  79. }
  80. - (BOOL)supportsActiveProperty {
  81. return [self.layoutConstraint respondsToSelector:@selector(isActive)];
  82. }
  83. - (BOOL)isActive {
  84. BOOL active = YES;
  85. if ([self supportsActiveProperty]) {
  86. active = [self.layoutConstraint isActive];
  87. }
  88. return active;
  89. }
  90. - (BOOL)hasBeenInstalled {
  91. return (self.layoutConstraint != nil) && [self isActive];
  92. }
  93. - (void)setSecondViewAttribute:(id)secondViewAttribute {
  94. if ([secondViewAttribute isKindOfClass:NSValue.class]) {
  95. [self setLayoutConstantWithValue:secondViewAttribute];
  96. } else if ([secondViewAttribute isKindOfClass:MAS_VIEW.class]) {
  97. _secondViewAttribute = [[MASViewAttribute alloc] initWithView:secondViewAttribute layoutAttribute:self.firstViewAttribute.layoutAttribute];
  98. } else if ([secondViewAttribute isKindOfClass:MASViewAttribute.class]) {
  99. _secondViewAttribute = secondViewAttribute;
  100. } else {
  101. NSAssert(NO, @"attempting to add unsupported attribute: %@", secondViewAttribute);
  102. }
  103. }
  104. #pragma mark - NSLayoutConstraint multiplier proxies
  105. - (MASConstraint * (^)(CGFloat))multipliedBy {
  106. return ^id(CGFloat multiplier) {
  107. NSAssert(!self.hasBeenInstalled,
  108. @"Cannot modify constraint multiplier after it has been installed");
  109. self.layoutMultiplier = multiplier;
  110. return self;
  111. };
  112. }
  113. - (MASConstraint * (^)(CGFloat))dividedBy {
  114. return ^id(CGFloat divider) {
  115. NSAssert(!self.hasBeenInstalled,
  116. @"Cannot modify constraint multiplier after it has been installed");
  117. self.layoutMultiplier = 1.0/divider;
  118. return self;
  119. };
  120. }
  121. #pragma mark - MASLayoutPriority proxy
  122. - (MASConstraint * (^)(MASLayoutPriority))priority {
  123. return ^id(MASLayoutPriority priority) {
  124. NSAssert(!self.hasBeenInstalled,
  125. @"Cannot modify constraint priority after it has been installed");
  126. self.layoutPriority = priority;
  127. return self;
  128. };
  129. }
  130. #pragma mark - NSLayoutRelation proxy
  131. - (MASConstraint * (^)(id, NSLayoutRelation))equalToWithRelation {
  132. return ^id(id attribute, NSLayoutRelation relation) {
  133. if ([attribute isKindOfClass:NSArray.class]) {
  134. NSAssert(!self.hasLayoutRelation, @"Redefinition of constraint relation");
  135. NSMutableArray *children = NSMutableArray.new;
  136. for (id attr in attribute) {
  137. MASViewConstraint *viewConstraint = [self copy];
  138. viewConstraint.secondViewAttribute = attr;
  139. [children addObject:viewConstraint];
  140. }
  141. MASCompositeConstraint *compositeConstraint = [[MASCompositeConstraint alloc] initWithChildren:children];
  142. compositeConstraint.delegate = self.delegate;
  143. [self.delegate constraint:self shouldBeReplacedWithConstraint:compositeConstraint];
  144. return compositeConstraint;
  145. } else {
  146. NSAssert(!self.hasLayoutRelation || self.layoutRelation == relation && [attribute isKindOfClass:NSValue.class], @"Redefinition of constraint relation");
  147. self.layoutRelation = relation;
  148. self.secondViewAttribute = attribute;
  149. return self;
  150. }
  151. };
  152. }
  153. #pragma mark - Semantic properties
  154. - (MASConstraint *)with {
  155. return self;
  156. }
  157. - (MASConstraint *)and {
  158. return self;
  159. }
  160. #pragma mark - attribute chaining
  161. - (MASConstraint *)addConstraintWithLayoutAttribute:(NSLayoutAttribute)layoutAttribute {
  162. NSAssert(!self.hasLayoutRelation, @"Attributes should be chained before defining the constraint relation");
  163. return [self.delegate constraint:self addConstraintWithLayoutAttribute:layoutAttribute];
  164. }
  165. #pragma mark - Animator proxy
  166. #if TARGET_OS_MAC && !TARGET_OS_IPHONE
  167. - (MASConstraint *)animator {
  168. self.useAnimator = YES;
  169. return self;
  170. }
  171. #endif
  172. #pragma mark - debug helpers
  173. - (MASConstraint * (^)(id))key {
  174. return ^id(id key) {
  175. self.mas_key = key;
  176. return self;
  177. };
  178. }
  179. #pragma mark - NSLayoutConstraint constant setters
  180. - (void)setInsets:(MASEdgeInsets)insets {
  181. NSLayoutAttribute layoutAttribute = self.firstViewAttribute.layoutAttribute;
  182. switch (layoutAttribute) {
  183. case NSLayoutAttributeLeft:
  184. case NSLayoutAttributeLeading:
  185. self.layoutConstant = insets.left;
  186. break;
  187. case NSLayoutAttributeTop:
  188. self.layoutConstant = insets.top;
  189. break;
  190. case NSLayoutAttributeBottom:
  191. self.layoutConstant = -insets.bottom;
  192. break;
  193. case NSLayoutAttributeRight:
  194. case NSLayoutAttributeTrailing:
  195. self.layoutConstant = -insets.right;
  196. break;
  197. default:
  198. break;
  199. }
  200. }
  201. - (void)setOffset:(CGFloat)offset {
  202. self.layoutConstant = offset;
  203. }
  204. - (void)setSizeOffset:(CGSize)sizeOffset {
  205. NSLayoutAttribute layoutAttribute = self.firstViewAttribute.layoutAttribute;
  206. switch (layoutAttribute) {
  207. case NSLayoutAttributeWidth:
  208. self.layoutConstant = sizeOffset.width;
  209. break;
  210. case NSLayoutAttributeHeight:
  211. self.layoutConstant = sizeOffset.height;
  212. break;
  213. default:
  214. break;
  215. }
  216. }
  217. - (void)setCenterOffset:(CGPoint)centerOffset {
  218. NSLayoutAttribute layoutAttribute = self.firstViewAttribute.layoutAttribute;
  219. switch (layoutAttribute) {
  220. case NSLayoutAttributeCenterX:
  221. self.layoutConstant = centerOffset.x;
  222. break;
  223. case NSLayoutAttributeCenterY:
  224. self.layoutConstant = centerOffset.y;
  225. break;
  226. default:
  227. break;
  228. }
  229. }
  230. #pragma mark - MASConstraint
  231. - (void)activate {
  232. if ([self supportsActiveProperty] && self.layoutConstraint) {
  233. if (self.hasBeenInstalled) {
  234. return;
  235. }
  236. self.layoutConstraint.active = YES;
  237. [self.firstViewAttribute.view.mas_installedConstraints addObject:self];
  238. } else {
  239. [self install];
  240. }
  241. }
  242. - (void)deactivate {
  243. if ([self supportsActiveProperty]) {
  244. self.layoutConstraint.active = NO;
  245. [self.firstViewAttribute.view.mas_installedConstraints removeObject:self];
  246. } else {
  247. [self uninstall];
  248. }
  249. }
  250. - (void)install {
  251. if (self.hasBeenInstalled) {
  252. return;
  253. }
  254. MAS_VIEW *firstLayoutItem = self.firstViewAttribute.item;
  255. NSLayoutAttribute firstLayoutAttribute = self.firstViewAttribute.layoutAttribute;
  256. MAS_VIEW *secondLayoutItem = self.secondViewAttribute.item;
  257. NSLayoutAttribute secondLayoutAttribute = self.secondViewAttribute.layoutAttribute;
  258. // alignment attributes must have a secondViewAttribute
  259. // therefore we assume that is refering to superview
  260. // eg make.left.equalTo(@10)
  261. if (!self.firstViewAttribute.isSizeAttribute && !self.secondViewAttribute) {
  262. secondLayoutItem = self.firstViewAttribute.view.superview;
  263. secondLayoutAttribute = firstLayoutAttribute;
  264. }
  265. MASLayoutConstraint *layoutConstraint
  266. = [MASLayoutConstraint constraintWithItem:firstLayoutItem
  267. attribute:firstLayoutAttribute
  268. relatedBy:self.layoutRelation
  269. toItem:secondLayoutItem
  270. attribute:secondLayoutAttribute
  271. multiplier:self.layoutMultiplier
  272. constant:self.layoutConstant];
  273. layoutConstraint.priority = self.layoutPriority;
  274. layoutConstraint.mas_key = self.mas_key;
  275. if (self.secondViewAttribute.view) {
  276. MAS_VIEW *closestCommonSuperview = [self.firstViewAttribute.view mas_closestCommonSuperview:self.secondViewAttribute.view];
  277. NSAssert(closestCommonSuperview,
  278. @"couldn't find a common superview for %@ and %@",
  279. self.firstViewAttribute.view, self.secondViewAttribute.view);
  280. self.installedView = closestCommonSuperview;
  281. } else if (self.firstViewAttribute.isSizeAttribute) {
  282. self.installedView = self.firstViewAttribute.view;
  283. } else {
  284. self.installedView = self.firstViewAttribute.view.superview;
  285. }
  286. MASLayoutConstraint *existingConstraint = nil;
  287. if (self.updateExisting) {
  288. existingConstraint = [self layoutConstraintSimilarTo:layoutConstraint];
  289. }
  290. if (existingConstraint) {
  291. // just update the constant
  292. existingConstraint.constant = layoutConstraint.constant;
  293. self.layoutConstraint = existingConstraint;
  294. } else {
  295. [self.installedView addConstraint:layoutConstraint];
  296. self.layoutConstraint = layoutConstraint;
  297. [firstLayoutItem.mas_installedConstraints addObject:self];
  298. }
  299. }
  300. - (MASLayoutConstraint *)layoutConstraintSimilarTo:(MASLayoutConstraint *)layoutConstraint {
  301. // check if any constraints are the same apart from the only mutable property constant
  302. // go through constraints in reverse as we do not want to match auto-resizing or interface builder constraints
  303. // and they are likely to be added first.
  304. for (NSLayoutConstraint *existingConstraint in self.installedView.constraints.reverseObjectEnumerator) {
  305. if (![existingConstraint isKindOfClass:MASLayoutConstraint.class]) continue;
  306. if (existingConstraint.firstItem != layoutConstraint.firstItem) continue;
  307. if (existingConstraint.secondItem != layoutConstraint.secondItem) continue;
  308. if (existingConstraint.firstAttribute != layoutConstraint.firstAttribute) continue;
  309. if (existingConstraint.secondAttribute != layoutConstraint.secondAttribute) continue;
  310. if (existingConstraint.relation != layoutConstraint.relation) continue;
  311. if (existingConstraint.multiplier != layoutConstraint.multiplier) continue;
  312. if (existingConstraint.priority != layoutConstraint.priority) continue;
  313. return (id)existingConstraint;
  314. }
  315. return nil;
  316. }
  317. - (void)uninstall {
  318. [self.installedView removeConstraint:self.layoutConstraint];
  319. self.layoutConstraint = nil;
  320. self.installedView = nil;
  321. [self.firstViewAttribute.view.mas_installedConstraints removeObject:self];
  322. }
  323. @end