CTFrame.h学习

2017-03-02

CTFrame 相当于布局控制文件。控制文本的整体绘制。

我们从三个方面来看这个类

frame 访问函数
frame values
frame types

1. frame 访问函数

1
2
3

void CTFrameDraw(CTFrameRef frame,CGContextRef context )` 
将文本呈现在屏幕上

1
2
3

void CTFrameGetLineOrigins(CTFrameRef frame,CFRange range,CGPoint origins[] )
获取range范围内frame每行的起点 range 需要解释下 range.location 是 从第几个开始返回point  range.len 是返回几个，要是0就默认返回都最后一个。要是range 的location + len 大于CTLine的数量，所有的origins 都会是（0，0） 获取的坐标点是 coretext坐标系中的坐标

CFArrayRef CTFrameGetLines(CTFrameRef frame )
获取frame所有线的数组，frame是由CTLine组成的
   NSArray * array = (__bridge NSArray * )CTFrameGetLines(frame);
    NSLog(@"frame lines %@",array);

1
2
3

CFDictionaryRef __nullable CTFrameGetFrameAttributes(CTFrameRef frame )
获取修饰frame的相关属性

1
2
3

CGPathRef CTFrameGetPath(CTFrameRef frame )
获取frame绘制的路径不包括剪切路径

CFRange CTFrameGetVisibleStringRange(CTFrameRef frame ) 
获取frame 能看见的，绘制在屏幕上的string 的range范围
CFRange CTFrameGetStringRange(CTFrameRef frame )
获取frame 字符串的范围(包括不可见的)

测试代码

- (void)drawRect:(CGRect)rect {
    CGContextRef context = UIGraphicsGetCurrentContext();
    CGContextSetTextMatrix(context , CGAffineTransformIdentity);
    CGContextTranslateCTM(context , 0 ,self.bounds.size.height);
        CGContextScaleCTM(context, 1.0 ,-1.0);
    
    NSMutableAttributedString *mabstring = [[NSMutableAttributedString alloc]initWithString:@"富文本学习/慢慢来吧。不是一朝一夕之功。ok \n ok ok"];
    
    CTFramesetterRef framesetter = CTFramesetterCreateWithAttributedString((CFAttributedStringRef)mabstring);
    
    CGMutablePathRef Path = CGPathCreateMutable();
    CGPathAddRect(Path, NULL ,CGRectMake(10 , 0 ,self.bounds.size.width-10 , self.bounds.size.height-640));
    CTFrameRef frame = CTFramesetterCreateFrame(framesetter, CFRangeMake(0, 0), Path, NULL);
    
    ///frame 相关访问函数 相当于布局控制器。我们能获取布局控制器相关参数
    CTFrameDraw(frame,context);
    NSArray * array = (__bridge NSArray * )CTFrameGetLines(frame);
    NSLog(@"frame lines %@",array);
    
    NSInteger count = CFArrayGetCount((__bridge CFArrayRef)array);
    CGPoint  origins[count] ;
    ///range 需要解释下 range.location 是 从第几个开始返回point  range.len 是返回几个，要是0就默认返回都最后一个。要是range 的location + len 大于CTLine的数量，所有的origins 都会是（0，0） 获取的坐标点是 coretext坐标系中的坐标 
    CTFrameGetLineOrigins(frame, CFRangeMake(0, 0), origins);
    for (int i =0; i<count; i++) {
        NSLog(@"frame origins %f %f",origins[i].x,origins[i].y);
    }
   NSDictionary * dic = (__bridge NSDictionary *) CTFrameGetFrameAttributes(frame);
    NSLog(@"frame att %@",dic);
    
    CGPathRef path = CTFrameGetPath(frame);
    NSLog(@"frame path %@",path);
    
    CFRange range =  CTFrameGetVisibleStringRange(frame);
    NSLog(@"frame visibleString Range %ld  %ld",range.location,range.length);
    
    range =  CTFrameGetStringRange(frame);
    NSLog(@"frame String Range %ld  %ld",range.location,range.length);
    
    CGPathRelease(Path);
    CFRelease(framesetter);
}

结果

2017-02-23 15:19:42.578 CoreTextDemo[83004:902122] frame lines (
    "<CTLine: 0x6080001ae8c0>{run count = 4, string range = (0, 24), width = 250.676, A/D/L = 12.72/4.08/0, glyph count = 24, runs = (\n\n<CTRun: 0x7f8539f09720>{string range = (0, 5), string = \"\\u5BCC\\u6587\\u672C\\u5B66\\u4E60\", attributes = <CFBasicHash 0x608000267e40 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e05c788 [0x10d69fc70]>{contents = \"NSFont\"} = <CTFont: 0x7f8539f1f160>{name = PingFangSC-Regular, size = 12.000000, matrix = 0x0, descriptor = <CTFontDescriptor: 0x608000086a90>{attributes = <CFBasicHash 0x608000261640 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e062908 [0x10d69fc70]>{contents = \"NSFontNameAttribute\"} = <CFString 0x11af8e6c0 [0x10d69fc70]>{contents = \"PingFangSC-Regular\"}\n}\n>}}\n}\n}\n\n\n<CTRun: 0x7f8539f0de20>{string range = (5, 1), string = \"/\", attributes = <CFBasicHash 0x6080002609c0 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e05c788 [0x10d69fc70]>{contents = \"NSFont\"} = <CTFont: 0x7f8539f04950>{name = Helvetica, size = 12.000000, matrix = 0x0, descriptor = <CTFontDescriptor: 0x600000085960>{attributes = <CFBasicHash 0x60000007dd40 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e062908 [0x10d69fc70]>{contents = \"NSFontNameAttribute\"} = <CFString 0x10e0548a8 [0x10d69fc70]>{contents = \"Helvetica\"}\n}\n>}}\n}\n}\n\n\n<CTRun: 0x7f8539f2e9b0>{string range = (6, 14), string = \"\\u6162\\u6162\\u6765\\u5427\\u3002\\u4E0D\\u662F\\u4E00\\u671D\\u4E00\\u5915\\u4E4B\\u529F\\u3002\", attributes = <CFBasicHash 0x608000267e40 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e05c788 [0x10d69fc70]>{contents = \"NSFont\"} = <CTFont: 0x7f8539f1f160>{name = PingFangSC-Regular, size = 12.000000, matrix = 0x0, descriptor = <CTFontDescriptor: 0x608000086a90>{attributes = <CFBasicHash 0x608000261640 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e062908 [0x10d69fc70]>{contents = \"NSFontNameAttribute\"} = <CFString 0x11af8e6c0 [0x10d69fc70]>{contents = \"PingFangSC-Regular\"}\n}\n>}}\n}\n}\n\n\n<CTRun: 0x7f8539f2eaf0>{string range = (20, 4), string = \"ok \\n\", attributes = <CFBasicHash 0x6080002609c0 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e05c788 [0x10d69fc70]>{contents = \"NSFont\"} = <CTFont: 0x7f8539f04950>{name = Helvetica, size = 12.000000, matrix = 0x0, descriptor = <CTFontDescriptor: 0x600000085960>{attributes = <CFBasicHash 0x60000007dd40 [0x10d69fc70]>{type = mutable dict, count = 1,\nentries =>\n\t2 : <CFString 0x10e062908 [0x10d69fc70]>{contents = \"NSFontNameAttribute\"} = <CFString 0x10e0548a8 [0x10d69fc70]>{contents = \"Helvetica\"}\n}\n>}}\n}\n}\n\n)\n}"
)
2017-02-23 15:19:42.578 CoreTextDemo[83004:902122] frame origins 0.000000 14.000000
2017-02-23 15:19:42.579 CoreTextDemo[83004:902122] frame att (null)
2017-02-23 15:19:42.579 CoreTextDemo[83004:902122] frame path <CGPath 0x60800003a300>
2017-02-23 15:19:42.579 CoreTextDemo[83004:902122] frame visibleString Range 0  24
2017-02-23 15:19:42.580 CoreTextDemo[83004:902122] frame String Range 0  30

从上面结果看 frame 没有设置 att 属性。那怎么设置属性值呢？请看 CTFramesetterRef

2 frame values

下面是frame att 属性的key 通过这些key 可以控制 frame 的绘制布局

kCTFrameProgressionAttributeName	文字绘制方向，有三个值， kCTFrameProgressionTopToBottom水平绘制从上到下， kCTFrameProgressionRightToLeft 垂直绘制，从右到左， kCTFrameProgressionLeftToRight 垂直绘制，从左到右
kCTFramePathFillRuleAttributeName	在path路径的绘制规则。有两种 kCTFramePathFillEvenOdd 根据 CGContextEOFillPath 规则绘制 kCTFramePathFillWindingNumber 充满整个path 默认是kCTFramePathFillEvenOdd
kCTFramePathWidthAttributeName	这个属性暂时不知道干嘛用的，使用起来无效（已解决）
kCTFrameClippingPathsAttributeName	这个value 是array ，array 中必须包含字典，字典的key值是kCTFramePathClippingPathAttributeName ，value是path，可选key kCTFramePathFillRuleAttributeName 可以配置path路径的填充方式
kCTFramePathClippingPathAttributeName	这个value是path

kCTFrameProgressionAttributeName

1
2
3

NSMutableDictionary * Framedic = [NSMutableDictionary dictionary];
  [Framedic setObject:@(kCTFrameProgressionLeftToRight) forKey:(__bridge NSString *)kCTFrameProgressionAttributeName];
  CTFrameRef frame = CTFramesetterCreateFrame(framesetter, CFRangeMake(0, 0), Path, (__bridge CFDictionaryRef) Framedic);

效果

kCTFrameProgressionRightToLeft

1
2
3

NSMutableDictionary * Framedic = [NSMutableDictionary dictionary];
 [Framedic setObject:@(kCTFrameProgressionRightToLeft) forKey:(__bridge NSString *)kCTFrameProgressionAttributeName];
 CTFrameRef frame = CTFramesetterCreateFrame(framesetter, CFRangeMake(0, 0), Path, (__bridge CFDictionaryRef) Framedic);

效果

默认是kCTFrameProgressionTopToBottom

kCTFramePathFillRuleAttributeName

我认为这个主要是填充path 规则的 kCTFramePathFillEvenOdd 这种方式进行理解

什么是 CGContextEOFillPath 规则 //使用奇偶规则填充当前路径

修改路径代码如下：使一个大的矩形套一个小的矩形

1
2
3

CGMutablePathRef Path = CGPathCreateMutable();
   CGPathAddRect(Path, NULL ,CGRectMake(10 , 0 ,self.bounds.size.width-10 , self.bounds.size.height-60));
   CGPathAddRect(Path, NULL ,CGRectMake(100 , 0 ,self.bounds.size.width-150 , self.bounds.size.height-60));

结果显示

kCTFrameClippingPathsAttributeName 和 kCTFramePathClippingPathAttributeName

NSMutableArray * arr = [NSMutableArray array];
NSMutableDictionary * fillDic = [NSMutableDictionary dictionary];
CGMutablePathRef clippath = CGPathCreateMutable();
CGPathAddRect(clippath, NULL ,CGRectMake(100 , 20 ,self.bounds.size.width-150 , self.bounds.size.height-60));
[fillDic setObject:(__bridge id _Nonnull)(clippath) forKey:(__bridge NSString *)kCTFramePathClippingPathAttributeName];
[arr addObject:fillDic];
fillDic = [NSMutableDictionary dictionary];
 clippath = CGPathCreateMutable();
CGPathAddRect(clippath, NULL ,CGRectMake(10 , 20 ,10 , self.bounds.size.height-60));
[fillDic setObject:(__bridge id _Nonnull)(clippath) forKey:(__bridge NSString *)kCTFramePathClippingPathAttributeName];
[arr addObject:fillDic];
[Framedic setObject:arr forKey:(__bridge NSString *)kCTFrameClippingPathsAttributeName];

剪切上面的路径。与 kCTFramePathFillRuleAttributeName 暂时看不出变化来，应该是这个里面的路径全部clip。可能与path 重叠有关系，目前没做具体研究。（已验证,见最后模块）

3 frame types

CFTypeID CTFrameGetTypeID( void )

返回一个CFTypeID

综合CFFrame.h api ，可以看出该类能获取到frame的信息是 CTLIne 和CTLine 的起点。

见图

上图不包含剪切的路径。

已解决问题

kCTFramePathWidthAttributeName 这个属性如果是修饰 CTframeRef 的话相当于边距

CGContextRef context = UIGraphicsGetCurrentContext();
CGContextSetTextMatrix(context , CGAffineTransformIdentity);
CGContextTranslateCTM(context , 0 ,self.bounds.size.height);
    CGContextScaleCTM(context, 1.0 ,-1.0);
NSMutableAttributedString *mabstring = [[NSMutableAttributedString alloc]initWithString:@"富文本学习/慢慢来吧。不是一朝一夕之功。ok \n ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok"];
CTFramesetterRef framesetter = CTFramesetterCreateWithAttributedString((CFAttributedStringRef)mabstring);
CGMutablePathRef Path = CGPathCreateMutable();
CGPathAddRect(Path, NULL ,CGRectMake(0 , 0 ,self.bounds.size.width , self.bounds.size.height-60));
NSMutableDictionary * Framedic = [NSMutableDictionary dictionary];
[Framedic setObject:@(kCTFrameProgressionTopToBottom) forKey:(__bridge NSString *)kCTFrameProgressionAttributeName];
[Framedic setObject:@(kCTFramePathFillEvenOdd) forKey:(__bridge NSString *)kCTFramePathFillRuleAttributeName];
UIView * view = [[UIView alloc]initWithFrame:CGRectMake(0, 0, 15, self.bounds.size.height)];
view.backgroundColor = [UIColor redColor];
[self addSubview:view];
view = [[UIView alloc]initWithFrame:CGRectMake(self.bounds.size.width-15, 0, 15, self.bounds.size.height)];
view.backgroundColor = [UIColor redColor];
[self addSubview:view];
[Framedic setObject:@(30) forKey:(__bridge NSString *)    kCTFramePathWidthAttributeName];
CFRange range = CFRangeMake(0, 0);
CTFrameRef frame = CTFramesetterCreateFrame(framesetter,range, Path, (__bridge CFDictionaryRef) Framedic);
CGRect rectBoud = CGPathGetBoundingBox(Path);
CFRange fitRange = CFRangeMake(0, 0);
CGSize size =CTFramesetterSuggestFrameSizeWithConstraints(framesetter, range, (__bridge CFDictionaryRef) Framedic, rectBoud.size, &fitRange);
NSLog(@" 获取frame 的大小 %f %f %ld %ld",size.height,size.width,fitRange.location,fitRange.location);
///frame 相关访问函数 相当于布局控制器。我们能获取布局控制器相关参数
CTFrameDraw(frame,context);

结果：

kCTFramePathWidthAttributeName 要是修饰clip 路径的话相当于边距加大

CGContextRef context = UIGraphicsGetCurrentContext();
CGContextSetTextMatrix(context , CGAffineTransformIdentity);
CGContextTranslateCTM(context , 0 ,self.bounds.size.height);
    CGContextScaleCTM(context, 1.0 ,-1.0);
NSMutableAttributedString *mabstring = [[NSMutableAttributedString alloc]initWithString:@"富文本学习/慢慢来吧。不是一朝一夕之功。ok \n ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok"];
CTFramesetterRef framesetter = CTFramesetterCreateWithAttributedString((CFAttributedStringRef)mabstring);
CGMutablePathRef Path = CGPathCreateMutable();
CGPathAddRect(Path, NULL ,CGRectMake(0 , 0 ,self.bounds.size.width , self.bounds.size.height-60));
NSMutableDictionary * Framedic = [NSMutableDictionary dictionary];
[Framedic setObject:@(kCTFrameProgressionTopToBottom) forKey:(__bridge NSString *)kCTFrameProgressionAttributeName];
[Framedic setObject:@(kCTFramePathFillEvenOdd) forKey:(__bridge NSString *)kCTFramePathFillRuleAttributeName];
NSMutableArray * arr = [NSMutableArray array];
NSMutableDictionary * fillDic = [NSMutableDictionary dictionary];
CGMutablePathRef clippath = CGPathCreateMutable();
CGPathAddRect(clippath, NULL ,CGRectMake(100 , 20 ,self.bounds.size.width-150 , self.bounds.size.height-60));
[fillDic setObject:(__bridge id _Nonnull)(clippath) forKey:(__bridge NSString *)kCTFramePathClippingPathAttributeName];
[fillDic setObject:@(40) forKey:(__bridge NSString *)kCTFramePathWidthAttributeName];
[arr addObject:fillDic];
CGContextSetRGBFillColor(context, 1, 0, 0, 1);
CGContextAddPath(context, clippath);
CGContextDrawPath(context, kCGPathFill);
UIView * view =[[ UIView  alloc]initWithFrame:CGRectMake(100-20, 0, 20, self.bounds.size.height)];
view.backgroundColor = [UIColor greenColor];
[self addSubview:view];
view =[[ UIView  alloc]initWithFrame:CGRectMake(100+self.bounds.size.width-150, 0, 20, self.bounds.size.height)];
view.backgroundColor = [UIColor greenColor];
[self addSubview:view];
[Framedic setObject:arr forKey:(__bridge NSString *)kCTFrameClippingPathsAttributeName];
CFRange range = CFRangeMake(0, 0);
CTFrameRef frame = CTFramesetterCreateFrame(framesetter,range, Path, (__bridge CFDictionaryRef) Framedic);
CGRect rectBoud = CGPathGetBoundingBox(Path);
CFRange fitRange = CFRangeMake(0, 0);
CGSize size =CTFramesetterSuggestFrameSizeWithConstraints(framesetter, range, (__bridge CFDictionaryRef) Framedic, rectBoud.size, &fitRange);
NSLog(@" 获取frame 的大小 %f %f %ld %ld",size.height,size.width,fitRange.location,fitRange.location);
///frame 相关访问函数 相当于布局控制器。我们能获取布局控制器相关参数
CTFrameDraw(frame,context);

效果如下：

kCTFramePathFillRuleAttributeName 这个 kCTFramePathFillEvenOdd 规则的话是根据规则进行排版的。

代码：

    CGContextRef context = UIGraphicsGetCurrentContext();
    CGContextSetTextMatrix(context , CGAffineTransformIdentity);
    CGContextTranslateCTM(context , 0 ,self.bounds.size.height);
        CGContextScaleCTM(context, 1.0 ,-1.0);
    
    NSMutableAttributedString *mabstring = [[NSMutableAttributedString alloc]initWithString:@"富文本学习/慢慢来吧。不是一朝一夕之功。ok \n ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok富文本学习/慢慢来吧。不是一朝一夕之功。ok  ok ok"];
    
    CTFramesetterRef framesetter = CTFramesetterCreateWithAttributedString((CFAttributedStringRef)mabstring);
    
    CGMutablePathRef Path = CGPathCreateMutable();
    CGPathAddRect(Path, NULL ,CGRectMake(0 , 0 ,self.bounds.size.width , self.bounds.size.height-60));
    
    NSMutableDictionary * Framedic = [NSMutableDictionary dictionary];
    
    [Framedic setObject:@(kCTFrameProgressionTopToBottom) forKey:(__bridge NSString *)kCTFrameProgressionAttributeName];
    [Framedic setObject:@(kCTFramePathFillEvenOdd) forKey:(__bridge NSString *)kCTFramePathFillRuleAttributeName];
    NSMutableArray * arr = [NSMutableArray array];
    
    NSMutableDictionary * fillDic = [NSMutableDictionary dictionary];
    CGMutablePathRef clippath = CGPathCreateMutable();
    CGPathAddRect(clippath, NULL ,CGRectMake(100 , 20 ,self.bounds.size.width-250 , self.bounds.size.height-60));
    [fillDic setObject:(__bridge id _Nonnull)(clippath) forKey:(__bridge NSString *)kCTFramePathClippingPathAttributeName];
    [arr addObject:fillDic];
    CGContextSetRGBFillColor(context, 1, 0, 0, 0.5);
    CGContextAddPath(context, clippath);
    CGContextDrawPath(context, kCGPathFill);
    CGPathAddPath(Path, NULL, clippath);
    fillDic = [NSMutableDictionary dictionary];
    clippath = CGPathCreateMutable();
    
    CGPathAddRect(clippath, NULL ,CGRectMake(30 , 80 ,self.bounds.size.width-60 , self.bounds.size.height-60));
    [fillDic setObject:(__bridge id _Nonnull)(clippath) forKey:(__bridge NSString *)kCTFramePathClippingPathAttributeName];
    [arr addObject:fillDic];
    CGContextSetRGBFillColor(context, 0, 1, 0, 0.5);
    CGContextAddPath(context, clippath);
    CGContextDrawPath(context, kCGPathFill);
    CGPathAddPath(Path, NULL, clippath);
  
    
//    [Framedic setObject:arr forKey:(__bridge NSString *)kCTFrameClippingPathsAttributeName];
    
    CFRange range = CFRangeMake(0, 0);
    CTFrameRef frame = CTFramesetterCreateFrame(framesetter,range, Path, (__bridge CFDictionaryRef) Framedic);
    
    CGRect rectBoud = CGPathGetBoundingBox(Path);
    CFRange fitRange = CFRangeMake(0, 0);
    
    CGSize size =CTFramesetterSuggestFrameSizeWithConstraints(framesetter, range, (__bridge CFDictionaryRef) Framedic, rectBoud.size, &fitRange);
    NSLog(@" 获取frame 的大小 %f %f %ld %ld",size.height,size.width,fitRange.location,fitRange.location);
    CTFrameDraw(frame,context);

效果图：

将上面的

1
2
3

    
//    [Framedic setObject:arr forKey:(__bridge NSString *)kCTFrameClippingPathsAttributeName];
打开

效果图：

很明显是所有的路径都被剪切掉了