MLLinkLabel.m 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538
  1. //
  2. // MLLinkLabel.m
  3. // MLLabel
  4. //
  5. // Created by molon on 15/6/6.
  6. // Copyright (c) 2015年 molon. All rights reserved.
  7. //
  8. #import "MLLinkLabel.h"
  9. #import "MLLabel+Override.h"
  10. #import "NSMutableAttributedString+MLLabel.h"
  11. #import "MLLabelLayoutManager.h"
  12. #define REGULAREXPRESSION_OPTION(regularExpression,regex,option) \
  13. \
  14. static NSRegularExpression * k##regularExpression() { \
  15. static NSRegularExpression *_##regularExpression = nil; \
  16. static dispatch_once_t onceToken; \
  17. dispatch_once(&onceToken, ^{ \
  18. _##regularExpression = [[NSRegularExpression alloc] initWithPattern:(regex) options:(option) error:nil];\
  19. });\
  20. \
  21. return _##regularExpression;\
  22. }\
  23. #define REGULAREXPRESSION(regularExpression,regex) REGULAREXPRESSION_OPTION(regularExpression,regex,NSRegularExpressionCaseInsensitive)
  24. REGULAREXPRESSION(URLRegularExpression,@"((http[s]{0,1}|ftp)://[a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,6})(:\\d+)?(/[a-zA-Z0-9\\.\\-~!@#$%^&*+?:_/=<>]*)?)|(www.[a-zA-Z0-9\\.\\-]+\\.([a-zA-Z]{2,6})(:\\d+)?(/[a-zA-Z0-9\\.\\-~!@#$%^&*+?:_/=<>]*)?)|(((http[s]{0,1}|ftp)://|)((?:(?:25[0-5]|2[0-4]\\d|((1\\d{2})|([1-9]?\\d)))\\.){3}(?:25[0-5]|2[0-4]\\d|((1\\d{2})|([1-9]?\\d))))(:\\d+)?(/[a-zA-Z0-9\\.\\-~!@#$%^&*+?:_/=<>]*)?)")
  25. REGULAREXPRESSION(PhoneNumerRegularExpression, @"\\d{3}-\\d{8}|\\d{3}-\\d{7}|\\d{4}-\\d{8}|\\d{4}-\\d{7}|1+[3578]+\\d{9}|[+]861+[3578]+\\d{9}|861+[3578]+\\d{9}|1+[3578]+\\d{1}-\\d{4}-\\d{4}|\\d{8}|\\d{7}|400-\\d{3}-\\d{4}|400-\\d{4}-\\d{3}")
  26. REGULAREXPRESSION(EmailRegularExpression, @"[A-Z0-9a-z\\._%+-]+@([A-Za-z0-9-]+\\.)+[A-Za-z]{2,6}")
  27. REGULAREXPRESSION(UserHandleRegularExpression, @"@[\\u4e00-\\u9fa5\\w\\-]+")
  28. REGULAREXPRESSION(HashtagRegularExpression, @"#([\\u4e00-\\u9fa5\\w\\-]+)")
  29. @interface MLLink()
  30. @property (nonatomic, assign) NSRange linkRange;
  31. @end
  32. @implementation MLLink
  33. + (instancetype)linkWithType:(MLLinkType)type value:(NSString*)value range:(NSRange)range
  34. {
  35. return [MLLink linkWithType:type value:value range:range linkTextAttributes:nil activeLinkTextAttributes:nil];
  36. }
  37. + (instancetype)linkWithType:(MLLinkType)type value:(NSString*)value range:(NSRange)range linkTextAttributes:(NSDictionary*)linkTextAttributes activeLinkTextAttributes:(NSDictionary*)activeLinkTextAttributes
  38. {
  39. MLLink *link = [MLLink new];
  40. link.linkType = type;
  41. link.linkValue = value;
  42. link.linkRange = range;
  43. link.linkTextAttributes = linkTextAttributes;
  44. link.activeLinkTextAttributes = activeLinkTextAttributes;
  45. return link;
  46. }
  47. @end
  48. @interface MLLinkLabel()<UIGestureRecognizerDelegate>
  49. @property (nonatomic, strong) NSMutableArray *links;
  50. @property (nonatomic, strong) MLLink *activeLink;
  51. @property (nonatomic, assign) BOOL dontReCreateLinks;
  52. @property (nonatomic, strong) UILongPressGestureRecognizer *longPressGestureRecognizer;
  53. @end
  54. @implementation MLLinkLabel
  55. #pragma mark - getter
  56. - (NSMutableArray *)links
  57. {
  58. if (!_links) {
  59. _links = [NSMutableArray array];
  60. }
  61. return _links;
  62. }
  63. - (UILongPressGestureRecognizer *)longPressGestureRecognizer
  64. {
  65. if (!_longPressGestureRecognizer) {
  66. _longPressGestureRecognizer = [[UILongPressGestureRecognizer alloc]initWithTarget:self action:@selector(longPressGestureDidFire:)];
  67. _longPressGestureRecognizer.delegate = self;
  68. }
  69. return _longPressGestureRecognizer;
  70. }
  71. #pragma mark - setter
  72. - (void)setActiveLink:(MLLink *)activeLink
  73. {
  74. BOOL isUnChanged = (!activeLink&&!_activeLink)||[activeLink isEqual:_activeLink];
  75. _activeLink = activeLink;
  76. if (isUnChanged) {
  77. return;
  78. }
  79. [self reSetText];
  80. [CATransaction flush];
  81. }
  82. - (void)setAllowLineBreakInsideLinks:(BOOL)allowLineBreakInsideLinks
  83. {
  84. if (allowLineBreakInsideLinks==_allowLineBreakInsideLinks) return;
  85. _allowLineBreakInsideLinks = allowLineBreakInsideLinks;
  86. [self reSetText];
  87. }
  88. - (void)setLinkTextAttributes:(NSDictionary *)linkTextAttributes
  89. {
  90. _linkTextAttributes = linkTextAttributes;
  91. [self reSetText];
  92. }
  93. - (void)setActiveLinkTextAttributes:(NSDictionary *)activeLinkTextAttributes
  94. {
  95. _activeLinkTextAttributes = activeLinkTextAttributes;
  96. [self reSetText];
  97. }
  98. - (void)setDataDetectorTypes:(MLDataDetectorTypes)dataDetectorTypes
  99. {
  100. _dataDetectorTypes = dataDetectorTypes;
  101. [super reSetText];
  102. }
  103. - (void)setDataDetectorTypesOfAttributedLinkValue:(MLDataDetectorTypes)dataDetectorTypesOfAttributedLinkValue
  104. {
  105. _dataDetectorTypesOfAttributedLinkValue = dataDetectorTypesOfAttributedLinkValue;
  106. [super reSetText];
  107. }
  108. #pragma mark - override
  109. - (void)reSetText
  110. {
  111. //标记不重新生成链接,因为修改label的样式,例如字体啊什么的,父类会调用reSetText方法。而这时候如果依然重新生成link的话,会引起addLink方式后添加的link丢失。
  112. //然后此类内部所有需要重新生成链接的都是调用[super reSetText],否则只是需要重绘的调用[self reSetText]
  113. self.dontReCreateLinks = YES;
  114. [super reSetText];
  115. self.dontReCreateLinks = NO;
  116. }
  117. - (void)commonInit
  118. {
  119. [super commonInit];
  120. self.exclusiveTouch = YES;
  121. self.userInteractionEnabled = YES;
  122. self.activeLinkToNilDelay = 0.3f;
  123. //默认除了话题和@都检测
  124. _dataDetectorTypes = MLDataDetectorTypeURL|MLDataDetectorTypePhoneNumber|MLDataDetectorTypeEmail|MLDataDetectorTypeAttributedLink;
  125. _dataDetectorTypesOfAttributedLinkValue = MLDataDetectorTypeNone;
  126. _allowLineBreakInsideLinks = YES;
  127. [self addGestureRecognizer:self.longPressGestureRecognizer];
  128. }
  129. - (void)setText:(NSString *)text
  130. {
  131. //先提取出来links
  132. if (!self.dontReCreateLinks) {
  133. self.links = [self linksWithString:text];
  134. _activeLink = nil; //这里不能走setter
  135. }
  136. [super setText:text];
  137. }
  138. - (void)setAttributedText:(NSAttributedString *)attributedText
  139. {
  140. //先提取出来links
  141. if (!self.dontReCreateLinks) {
  142. self.links = [self linksWithString:attributedText];
  143. _activeLink = nil; //这里不能走setter
  144. }
  145. [super setAttributedText:attributedText];
  146. }
  147. - (NSMutableAttributedString*)attributedTextForTextStorageFromLabelProperties
  148. {
  149. NSMutableAttributedString *attributedString = [super attributedTextForTextStorageFromLabelProperties];
  150. //默认的链接样式不是我们想要的,去除它
  151. [attributedString removeAttribute:NSLinkAttributeName range:NSMakeRange(0, attributedString.length)];
  152. //检测是否有链接,有的话就直接给设置链接样式
  153. for (MLLink *link in self.links) {
  154. NSDictionary *attributes = nil;
  155. if ([link isEqual:self.activeLink]) {
  156. attributes = link.activeLinkTextAttributes?link.activeLinkTextAttributes:self.activeLinkTextAttributes;
  157. if (!attributes) {
  158. attributes = @{NSForegroundColorAttributeName:kDefaultLinkColorForMLLinkLabel,NSBackgroundColorAttributeName:kDefaultActiveLinkBackgroundColorForMLLinkLabel};
  159. }
  160. }else{
  161. attributes = link.linkTextAttributes?link.linkTextAttributes:self.linkTextAttributes;
  162. if (!attributes) {
  163. attributes = @{NSForegroundColorAttributeName:kDefaultLinkColorForMLLinkLabel};
  164. }
  165. }
  166. // [attributedString removeAttributes:[attributes allKeys] range:link.linkRange];
  167. [attributedString addAttributes:attributes range:link.linkRange];
  168. }
  169. return attributedString;
  170. }
  171. #pragma mark - 正则匹配相关
  172. static NSArray * kAllRegexps() {
  173. static NSArray *_allRegexps = nil;
  174. static dispatch_once_t onceToken;
  175. dispatch_once(&onceToken, ^{
  176. _allRegexps = @[kURLRegularExpression(),kPhoneNumerRegularExpression(),kEmailRegularExpression(),kUserHandleRegularExpression(),kHashtagRegularExpression()];
  177. });
  178. return _allRegexps;
  179. }
  180. - (NSArray*)regexpsWithDataDetectorTypes:(MLDataDetectorTypes)dataDetectorTypes
  181. {
  182. MLDataDetectorTypes const allDataDetectorTypes[] = {MLDataDetectorTypeURL,MLDataDetectorTypePhoneNumber,MLDataDetectorTypeEmail,MLDataDetectorTypeUserHandle,MLDataDetectorTypeHashtag};
  183. NSArray *allRegexps = kAllRegexps();
  184. NSMutableArray *regexps = [NSMutableArray array];
  185. for (NSInteger i=0; i<allRegexps.count; i++) {
  186. if (dataDetectorTypes&(allDataDetectorTypes[i])) {
  187. [regexps addObject:allRegexps[i]];
  188. }
  189. }
  190. //保证电话号码优先级最低,因为向下兼容,所以只能在此处理。
  191. NSRegularExpression *phoneNumberRegexp = kPhoneNumerRegularExpression();
  192. if ([regexps containsObject:phoneNumberRegexp]) {
  193. [regexps removeObject:phoneNumberRegexp];
  194. [regexps addObject:phoneNumberRegexp];
  195. }
  196. return regexps.count>0?regexps:nil;
  197. }
  198. //根据dataDetectorTypes和string获取其linkType
  199. - (MLLinkType)linkTypeOfString:(NSString*)string withDataDetectorTypes:(MLDataDetectorTypes)dataDetectorTypes
  200. {
  201. if (dataDetectorTypes == MLDataDetectorTypeNone) {
  202. return MLLinkTypeOther;
  203. }
  204. NSArray *allRegexps = kAllRegexps();
  205. NSArray *regexps = [self regexpsWithDataDetectorTypes:dataDetectorTypes];
  206. NSRange textRange = NSMakeRange(0, string.length);
  207. for (NSRegularExpression *regexp in regexps) {
  208. NSTextCheckingResult *result = [regexp firstMatchInString:string options:NSMatchingAnchored range:textRange];
  209. if (result&&NSEqualRanges(result.range, textRange)) {
  210. //这个type确定
  211. MLLinkType linkType = [allRegexps indexOfObject:regexp]+1;
  212. return linkType;
  213. }
  214. }
  215. return MLLinkTypeOther;
  216. }
  217. - (NSMutableArray*)linksWithString:(id)string
  218. {
  219. if (self.dataDetectorTypes == MLDataDetectorTypeNone||!string) {
  220. return nil;
  221. }
  222. NSString *plainText = [string isKindOfClass:[NSAttributedString class]]?((NSAttributedString*)string).string:string;
  223. if (plainText.length<=0) {
  224. return nil;
  225. }
  226. NSMutableArray *links = [NSMutableArray array];
  227. if ((self.dataDetectorTypes&MLDataDetectorTypeAttributedLink)&&[string isKindOfClass:[NSAttributedString class]]) {
  228. NSAttributedString *attributedString = ((NSAttributedString*)string);
  229. [attributedString enumerateAttribute:NSLinkAttributeName inRange:NSMakeRange(0, attributedString.length) options:0 usingBlock:^(id value, NSRange range, BOOL *stop) {
  230. if (value) {
  231. NSString *linkValue = nil;
  232. if ([value isKindOfClass:[NSURL class]]) {
  233. linkValue = [value absoluteString];
  234. }else if ([value isKindOfClass:[NSString class]]) {
  235. linkValue = value;
  236. }else if ([value isKindOfClass:[NSAttributedString class]]) {
  237. linkValue = [value string];
  238. }
  239. NSAssert(linkValue, @"The value of NSLinkAttributeName should be NSString/NSAttributedString/NSURL!");
  240. if (linkValue.length>0) {
  241. MLLink *link = [MLLink linkWithType:[self linkTypeOfString:linkValue withDataDetectorTypes:self.dataDetectorTypesOfAttributedLinkValue] value:linkValue range:range];
  242. if (self.beforeAddLinkBlock) {
  243. self.beforeAddLinkBlock(link);
  244. }
  245. [links addObject:link];
  246. }
  247. }
  248. }];
  249. }
  250. NSArray *allRegexps = kAllRegexps();
  251. NSArray *regexps = [self regexpsWithDataDetectorTypes:self.dataDetectorTypes];
  252. NSRange textRange = NSMakeRange(0, plainText.length);
  253. for (NSRegularExpression *regexp in regexps) {
  254. [regexp enumerateMatchesInString:plainText options:0 range:textRange usingBlock:^(NSTextCheckingResult *result, __unused NSMatchingFlags flags, __unused BOOL *stop) {
  255. //去重处理
  256. for (MLLink *link in links){
  257. if (NSMaxRange(NSIntersectionRange(link.linkRange, result.range))>0){
  258. return;
  259. }
  260. }
  261. //这个刚好和MLLinkType对应
  262. MLLinkType linkType = [allRegexps indexOfObject:regexp]+1;
  263. if (linkType!=MLLinkTypeNone) {
  264. MLLink *link = [MLLink linkWithType:linkType value:[plainText substringWithRange:result.range] range:result.range];
  265. if (self.beforeAddLinkBlock) {
  266. self.beforeAddLinkBlock(link);
  267. }
  268. [links addObject:link];
  269. }
  270. }];
  271. }
  272. return links.count>0?links:nil;
  273. }
  274. #pragma mark - 链接点击交互相关
  275. - (MLLink *)linkAtPoint:(CGPoint)location
  276. {
  277. if (self.links.count<=0||self.text.length == 0||self.textContainer.size.width<=0||self.textContainer.size.height<=0) {
  278. return nil;
  279. }
  280. CGPoint textOffset;
  281. //在执行usedRectForTextContainer之前最好还是执行下glyphRangeForTextContainer relayout
  282. [self.layoutManager glyphRangeForTextContainer:self.textContainer];
  283. textOffset = [self textOffsetWithTextSize:[self.layoutManager usedRectForTextContainer:self.textContainer].size];
  284. //location转换成在textContainer的绘制区域的坐标
  285. location.x -= textOffset.x;
  286. location.y -= textOffset.y;
  287. //获取触摸的字形
  288. NSUInteger glyphIdx = [self.layoutManager glyphIndexForPoint:location inTextContainer:self.textContainer];
  289. //apple文档上写有说 如果location的区域没字形,可能返回的是最近的字形index,所以我们再找到这个字形所处于的rect来确认
  290. CGRect glyphRect = [self.layoutManager boundingRectForGlyphRange:NSMakeRange(glyphIdx, 1)
  291. inTextContainer:self.textContainer];
  292. if (!CGRectContainsPoint(glyphRect, location)) {
  293. return nil;
  294. }
  295. NSUInteger charIndex = [self.layoutManager characterIndexForGlyphAtIndex:glyphIdx];
  296. //找到了charIndex,然后去寻找是否这个字处于链接内部
  297. for (MLLink *link in self.links) {
  298. if (NSLocationInRange(charIndex,link.linkRange)) {
  299. return link;
  300. }
  301. }
  302. return nil;
  303. }
  304. - (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event
  305. {
  306. UITouch *touch = [touches anyObject];
  307. self.activeLink = [self linkAtPoint:[touch locationInView:self]];
  308. //如果已经触发了链接,就不朝上传递消息了
  309. if (!self.activeLink) {
  310. [super touchesBegan:touches withEvent:event];
  311. }
  312. }
  313. - (void)touchesMoved:(NSSet *)touches withEvent:(UIEvent *)event
  314. {
  315. //如果当前位置和之前的active的不一样的话,就认为不选那个链接了
  316. if (self.activeLink) {
  317. UITouch *touch = [touches anyObject];
  318. if (![self.activeLink isEqual:[self linkAtPoint:[touch locationInView:self]]]) {
  319. self.activeLink = nil;
  320. }
  321. } else {
  322. [super touchesMoved:touches withEvent:event];
  323. }
  324. }
  325. - (void)touchesEnded:(NSSet *)touches withEvent:(UIEvent *)event
  326. {
  327. if (self.activeLink) {
  328. NSString *linkText = [self.text substringWithRange:self.activeLink.linkRange];
  329. //告诉外面已经点击了某链接
  330. if (self.activeLink.didClickLinkBlock) {
  331. self.activeLink.didClickLinkBlock(self.activeLink,linkText,self);
  332. }else if (self.didClickLinkBlock) {
  333. self.didClickLinkBlock(self.activeLink,linkText,self);
  334. }else if(self.delegate&&[self.delegate respondsToSelector:@selector(didClickLink:linkText:linkLabel:)]){
  335. [self.delegate didClickLink:self.activeLink linkText:linkText linkLabel:self];
  336. }
  337. [self performSelector:@selector(setActiveLink:) withObject:nil afterDelay:self.activeLinkToNilDelay];
  338. } else {
  339. [super touchesEnded:touches withEvent:event];
  340. }
  341. }
  342. - (void)touchesCancelled:(NSSet *)touches withEvent:(UIEvent *)event
  343. {
  344. if (self.activeLink) {
  345. self.activeLink = nil;
  346. } else {
  347. [super touchesCancelled:touches withEvent:event];
  348. }
  349. }
  350. #pragma mark - 长按相关
  351. - (BOOL)gestureRecognizer:(UIGestureRecognizer *)gestureRecognizer shouldReceiveTouch:(UITouch *)touch {
  352. MLLink *link = [self linkAtPoint:[touch locationInView:self]];
  353. if (link) {
  354. //检测是否有长按回调,没的话就不继续
  355. if ((self.delegate&&[self.delegate respondsToSelector:@selector(didLongPressLink:linkText:linkLabel:)])
  356. ||self.didLongPressLinkBlock
  357. ||link.didLongPressLinkBlock) {
  358. return YES;
  359. }
  360. }
  361. return NO;
  362. }
  363. - (void)longPressGestureDidFire:(UILongPressGestureRecognizer *)sender {
  364. if (sender.state==UIGestureRecognizerStateBegan) {
  365. MLLink *link = [self linkAtPoint:[sender locationInView:self]];
  366. if (link) {
  367. NSString *linkText = [self.text substringWithRange:link.linkRange];
  368. //告诉外面已经长按了某链接
  369. if (link.didLongPressLinkBlock) {
  370. link.didLongPressLinkBlock(link,linkText,self);
  371. }else if (self.didLongPressLinkBlock) {
  372. self.didLongPressLinkBlock(link,linkText,self);
  373. }else if (self.delegate&&[self.delegate respondsToSelector:@selector(didLongPressLink:linkText:linkLabel:)]){
  374. [self.delegate didLongPressLink:link linkText:linkText linkLabel:self];
  375. }
  376. }
  377. }
  378. }
  379. #pragma mark - 外部调用相关
  380. - (BOOL)addLink:(MLLink*)link
  381. {
  382. return [self addLinks:@[link]].count>0;
  383. }
  384. - (MLLink*)addLinkWithType:(MLLinkType)type value:(NSString*)value range:(NSRange)range
  385. {
  386. MLLink *link = [MLLink linkWithType:type value:value range:range];
  387. return [self addLink:link]?link:nil;
  388. }
  389. - (NSArray*)addLinks:(NSArray*)links
  390. {
  391. NSMutableArray *validLinks = [NSMutableArray arrayWithCapacity:links.count];
  392. for (MLLink *link in links) {
  393. if (!link||NSMaxRange(link.linkRange)>self.text.length) {
  394. continue;
  395. }
  396. //检测是否此位置已经有东西占用
  397. for (MLLink *aLink in self.links){
  398. if (NSMaxRange(NSIntersectionRange(aLink.linkRange, link.linkRange))>0){
  399. continue;
  400. }
  401. }
  402. if (self.beforeAddLinkBlock) {
  403. self.beforeAddLinkBlock(link);
  404. }
  405. //加入它
  406. [self.links addObject:link];
  407. [validLinks addObject:link];
  408. }
  409. //重绘
  410. [self reSetText];
  411. return validLinks;
  412. }
  413. - (void)invalidateDisplayForLinks
  414. {
  415. [self reSetText];
  416. }
  417. #pragma mark - 布局相关
  418. -(BOOL)layoutManager:(NSLayoutManager *)layoutManager shouldBreakLineByWordBeforeCharacterAtIndex:(NSUInteger)charIndex
  419. {
  420. if (self.lineBreakMode == NSLineBreakByCharWrapping) {
  421. return NO;
  422. }
  423. if (self.allowLineBreakInsideLinks) {
  424. return YES;
  425. }
  426. //让在链接区间下,尽量不break
  427. for (MLLink *link in self.links) {
  428. if (NSLocationInRange(charIndex,link.linkRange)) {
  429. return NO;
  430. }
  431. }
  432. return YES;
  433. }
  434. @end