de8040f3a6bf12f520faa90a8d89fe8b098d36b1
[WebKit-https.git] / Source / WebCore / PAL / pal / 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 #pragma once
27
28 #include <CoreText/CoreText.h>
29 #include <pal/spi/cg/CoreGraphicsSPI.h>
30
31 #if USE(APPLE_INTERNAL_SDK)
32
33 #include <CoreText/CoreTextPriv.h>
34
35 #else
36
37 enum {
38     kCTFontUIFontSystemItalic = 27,
39     kCTFontUIFontSystemThin = 102,
40     kCTFontUIFontSystemLight = 103,
41     kCTFontUIFontSystemUltraLight = 104,
42 };
43
44 typedef CF_OPTIONS(uint32_t, CTFontTransformOptions) {
45     kCTFontTransformApplyShaping = (1 << 0),
46     kCTFontTransformApplyPositioning = (1 << 1)
47 };
48
49 typedef CF_OPTIONS(uint32_t, CTFontDescriptorOptions) {
50     kCTFontDescriptorOptionSystemUIFont = 1 << 1,
51     kCTFontDescriptorOptionPreferAppleSystemFont = kCTFontOptionsPreferSystemFont
52 };
53
54 enum {
55     kCTRunStatusHasOrigins = (1 << 4),
56 };
57
58 #endif
59
60 WTF_EXTERN_C_BEGIN
61
62 typedef const UniChar* (*CTUniCharProviderCallback)(CFIndex stringIndex, CFIndex* charCount, CFDictionaryRef* attributes, void* refCon);
63 typedef void (*CTUniCharDisposeCallback)(const UniChar* chars, void* refCon);
64
65 extern const CFStringRef kCTFontReferenceURLAttribute;
66 extern const CFStringRef kCTFontOpticalSizeAttribute;
67 extern const CFStringRef kCTFontPostScriptNameAttribute;
68
69 bool CTFontTransformGlyphs(CTFontRef, CGGlyph glyphs[], CGSize advances[], CFIndex count, CTFontTransformOptions);
70
71 CGSize CTRunGetInitialAdvance(CTRunRef);
72 CTLineRef CTLineCreateWithUniCharProvider(CTUniCharProviderCallback, CTUniCharDisposeCallback, void* refCon);
73 void CTRunGetBaseAdvancesAndOrigins(CTRunRef, CFRange, CGSize baseAdvances[], CGPoint origins[]);
74 CTTypesetterRef CTTypesetterCreateWithUniCharProviderAndOptions(CTUniCharProviderCallback, CTUniCharDisposeCallback, void* refCon, CFDictionaryRef options);
75 bool CTFontGetVerticalGlyphsForCharacters(CTFontRef, const UniChar characters[], CGGlyph glyphs[], CFIndex count);
76 void CTFontGetUnsummedAdvancesForGlyphsAndStyle(CTFontRef, CTFontOrientation, CGFontRenderingStyle, const CGGlyph[], CGSize advances[], CFIndex count);
77
78 CTFontDescriptorRef CTFontDescriptorCreateForUIType(CTFontUIFontType, CGFloat size, CFStringRef language);
79 CTFontDescriptorRef CTFontDescriptorCreateWithTextStyle(CFStringRef style, CFStringRef size, CFStringRef language);
80 CTFontDescriptorRef CTFontDescriptorCreateCopyWithSymbolicTraits(CTFontDescriptorRef original, CTFontSymbolicTraits symTraitValue, CTFontSymbolicTraits symTraitMask);
81 CFBitVectorRef CTFontCopyGlyphCoverageForFeature(CTFontRef, CFDictionaryRef feature);
82
83 CTFontDescriptorRef CTFontDescriptorCreateWithAttributesAndOptions(CFDictionaryRef attributes, CTFontDescriptorOptions);
84 CTFontDescriptorRef CTFontDescriptorCreateLastResort();
85
86 extern const CFStringRef kCTFontCSSWeightAttribute;
87 extern const CFStringRef kCTFontCSSWidthAttribute;
88 extern const CFStringRef kCTFontDescriptorTextStyleAttribute;
89 extern const CFStringRef kCTFontUIFontDesignTrait;
90
91 extern const CFStringRef kCTFrameMaximumNumberOfLinesAttributeName;
92
93 bool CTFontDescriptorIsSystemUIFont(CTFontDescriptorRef);
94 CTFontRef CTFontCreateForCSS(CFStringRef name, uint16_t weight, CTFontSymbolicTraits, CGFloat size);
95 CTFontRef CTFontCreateForCharactersWithLanguage(CTFontRef currentFont, const UTF16Char *characters, CFIndex length, CFStringRef language, CFIndex *coveredLength);
96 CTFontRef CTFontCopyPhysicalFont(CTFontRef);
97
98 extern const CFStringRef kCTUIFontTextStyleShortHeadline;
99 extern const CFStringRef kCTUIFontTextStyleShortBody;
100 extern const CFStringRef kCTUIFontTextStyleShortSubhead;
101 extern const CFStringRef kCTUIFontTextStyleShortFootnote;
102 extern const CFStringRef kCTUIFontTextStyleShortCaption1;
103 extern const CFStringRef kCTUIFontTextStyleTallBody;
104
105 extern const CFStringRef kCTUIFontTextStyleHeadline;
106 extern const CFStringRef kCTUIFontTextStyleBody;
107 extern const CFStringRef kCTUIFontTextStyleSubhead;
108 extern const CFStringRef kCTUIFontTextStyleFootnote;
109 extern const CFStringRef kCTUIFontTextStyleCaption1;
110 extern const CFStringRef kCTUIFontTextStyleCaption2;
111
112 extern const CFStringRef kCTFontDescriptorTextStyleEmphasized;
113
114 extern const CGFloat kCTFontWeightUltraLight;
115 extern const CGFloat kCTFontWeightThin;
116 extern const CGFloat kCTFontWeightLight;
117 extern const CGFloat kCTFontWeightRegular;
118 extern const CGFloat kCTFontWeightMedium;
119 extern const CGFloat kCTFontWeightSemibold;
120 extern const CGFloat kCTFontWeightBold;
121 extern const CGFloat kCTFontWeightHeavy;
122 extern const CGFloat kCTFontWeightBlack;
123
124 extern const CFStringRef kCTUIFontTextStyleTitle0;
125 extern const CFStringRef kCTUIFontTextStyleTitle1;
126 extern const CFStringRef kCTUIFontTextStyleTitle2;
127 extern const CFStringRef kCTUIFontTextStyleTitle3;
128 extern const CFStringRef kCTUIFontTextStyleTitle4;
129 CTFontDescriptorRef CTFontCreatePhysicalFontDescriptorForCharactersWithLanguage(CTFontRef currentFont, const UTF16Char* characters, CFIndex length, CFStringRef language, CFIndex* coveredLength);
130
131 __attribute__((availability(macosx, obsoleted = 10.13))) __attribute__((availability(ios, obsoleted = 11.0))) CTFontRef CTFontCreatePhysicalFontForCharactersWithLanguage(CTFontRef, const UTF16Char* characters, CFIndex length, CFStringRef language, CFIndex* coveredLength);
132 bool CTFontIsAppleColorEmoji(CTFontRef);
133 CTFontRef CTFontCreateForCharacters(CTFontRef currentFont, const UTF16Char *characters, CFIndex length, CFIndex *coveredLength);
134
135 WTF_EXTERN_C_END