d44c628d89133c6b496914789e7995cc9281702e
[WebKit.git] / Source / WebCore / platform / spi / cocoa / CoreTextSPI.h
1 /*
2  * Copyright (C) 2014-2016 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef CoreTextSPI_h
27 #define CoreTextSPI_h
28
29 #include "CoreGraphicsSPI.h"
30 #include <CoreText/CoreText.h>
31
32 #if USE(APPLE_INTERNAL_SDK)
33
34 #include <CoreText/CoreTextPriv.h>
35
36 #else
37
38 enum {
39     kCTFontUIFontSystemItalic = 27,
40     kCTFontUIFontSystemThin = 102,
41     kCTFontUIFontSystemLight = 103,
42     kCTFontUIFontSystemUltraLight = 104,
43 };
44
45 typedef CF_OPTIONS(uint32_t, CTFontTransformOptions)
46 {
47     kCTFontTransformApplyShaping = (1 << 0),
48     kCTFontTransformApplyPositioning = (1 << 1)
49 };
50
51 typedef CF_OPTIONS(uint32_t, CTFontDescriptorOptions)
52 {
53     kCTFontDescriptorOptionSystemUIFont = 1 << 1,
54     kCTFontDescriptorOptionPreferAppleSystemFont = kCTFontOptionsPreferSystemFont
55 };
56
57 enum {
58     kCTRunStatusHasOrigins = (1 << 4),
59 };
60
61 #endif
62
63 WTF_EXTERN_C_BEGIN
64
65 typedef const UniChar* (*CTUniCharProviderCallback)(CFIndex stringIndex, CFIndex* charCount, CFDictionaryRef* attributes, void* refCon);
66 typedef void (*CTUniCharDisposeCallback)(const UniChar* chars, void* refCon);
67
68 extern const CFStringRef kCTFontReferenceURLAttribute;
69 extern const CFStringRef kCTFontOpticalSizeAttribute;
70 extern const CFStringRef kCTFontPostScriptNameAttribute;
71
72 bool CTFontTransformGlyphs(CTFontRef, CGGlyph glyphs[], CGSize advances[], CFIndex count, CTFontTransformOptions);
73
74 CGSize CTRunGetInitialAdvance(CTRunRef run);
75 CTLineRef CTLineCreateWithUniCharProvider(CTUniCharProviderCallback provide, CTUniCharDisposeCallback dispose, void* refCon);
76 void CTRunGetBaseAdvancesAndOrigins(CTRunRef, CFRange, CGSize baseAdvances[], CGPoint origins[]);
77 CTTypesetterRef CTTypesetterCreateWithUniCharProviderAndOptions(CTUniCharProviderCallback provide, CTUniCharDisposeCallback dispose, void* refCon, CFDictionaryRef options);
78 bool CTFontGetVerticalGlyphsForCharacters(CTFontRef, const UniChar characters[], CGGlyph glyphs[], CFIndex count);
79 void CTFontGetUnsummedAdvancesForGlyphsAndStyle(CTFontRef, CTFontOrientation, CGFontRenderingStyle, const CGGlyph[], CGSize advances[], CFIndex count);
80
81 CTFontDescriptorRef CTFontDescriptorCreateForUIType(CTFontUIFontType, CGFloat size, CFStringRef language);
82 CTFontDescriptorRef CTFontDescriptorCreateWithTextStyle(CFStringRef style, CFStringRef size, CFStringRef language);
83 CTFontDescriptorRef CTFontDescriptorCreateCopyWithSymbolicTraits(CTFontDescriptorRef original, CTFontSymbolicTraits symTraitValue, CTFontSymbolicTraits symTraitMask);
84 CFBitVectorRef CTFontCopyGlyphCoverageForFeature(CTFontRef, CFDictionaryRef feature);
85
86 CTFontDescriptorRef CTFontDescriptorCreateWithAttributesAndOptions(CFDictionaryRef attributes, CTFontDescriptorOptions);
87 CTFontDescriptorRef CTFontDescriptorCreateLastResort();
88
89 extern const CFStringRef kCTFontCSSWeightAttribute;
90 extern const CFStringRef kCTFontCSSWidthAttribute;
91 extern const CFStringRef kCTFontDescriptorTextStyleAttribute;
92 extern const CFStringRef kCTFontUIFontDesignTrait;
93
94 extern const CFStringRef kCTFrameMaximumNumberOfLinesAttributeName;
95
96 bool CTFontDescriptorIsSystemUIFont(CTFontDescriptorRef);
97 CTFontRef CTFontCreateForCSS(CFStringRef name, uint16_t weight, CTFontSymbolicTraits, CGFloat size);
98 CTFontRef CTFontCreateForCharactersWithLanguage(CTFontRef currentFont, const UTF16Char *characters, CFIndex length, CFStringRef language, CFIndex *coveredLength);
99
100 extern const CFStringRef kCTUIFontTextStyleShortHeadline;
101 extern const CFStringRef kCTUIFontTextStyleShortBody;
102 extern const CFStringRef kCTUIFontTextStyleShortSubhead;
103 extern const CFStringRef kCTUIFontTextStyleShortFootnote;
104 extern const CFStringRef kCTUIFontTextStyleShortCaption1;
105 extern const CFStringRef kCTUIFontTextStyleTallBody;
106
107 extern const CFStringRef kCTUIFontTextStyleHeadline;
108 extern const CFStringRef kCTUIFontTextStyleBody;
109 extern const CFStringRef kCTUIFontTextStyleSubhead;
110 extern const CFStringRef kCTUIFontTextStyleFootnote;
111 extern const CFStringRef kCTUIFontTextStyleCaption1;
112 extern const CFStringRef kCTUIFontTextStyleCaption2;
113
114 extern const CFStringRef kCTFontDescriptorTextStyleEmphasized;
115
116 extern const CGFloat kCTFontWeightUltraLight;
117 extern const CGFloat kCTFontWeightThin;
118 extern const CGFloat kCTFontWeightLight;
119 extern const CGFloat kCTFontWeightRegular;
120 extern const CGFloat kCTFontWeightMedium;
121 extern const CGFloat kCTFontWeightSemibold;
122 extern const CGFloat kCTFontWeightBold;
123 extern const CGFloat kCTFontWeightHeavy;
124 extern const CGFloat kCTFontWeightBlack;
125
126 extern const CFStringRef kCTUIFontTextStyleTitle0;
127 extern const CFStringRef kCTUIFontTextStyleTitle1;
128 extern const CFStringRef kCTUIFontTextStyleTitle2;
129 extern const CFStringRef kCTUIFontTextStyleTitle3;
130 extern const CFStringRef kCTUIFontTextStyleTitle4;
131 CTFontDescriptorRef CTFontCreatePhysicalFontDescriptorForCharactersWithLanguage(CTFontRef currentFont, const UTF16Char* characters, CFIndex length, CFStringRef language, CFIndex* coveredLength);
132
133 __attribute__((availability(macosx,obsoleted=10.13))) __attribute__((availability(ios,obsoleted=11.0))) CTFontRef CTFontCreatePhysicalFontForCharactersWithLanguage(CTFontRef, const UTF16Char* characters, CFIndex length, CFStringRef language, CFIndex* coveredLength);
134 bool CTFontIsAppleColorEmoji(CTFontRef);
135 CTFontRef CTFontCreateForCharacters(CTFontRef currentFont, const UTF16Char *characters, CFIndex length, CFIndex *coveredLength);
136
137 WTF_EXTERN_C_END
138
139 #endif