Unreviewed, fix iOS build with recent SDKs.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / NSAttributedString.h
1 /*
2  * Copyright (C) 2019 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import <WebKit/WKFoundation.h>
27
28 #if TARGET_OS_IPHONE
29 #import <UIKit/NSAttributedString.h>
30 #else
31 #import <AppKit/NSAttributedString.h>
32 #endif
33
34 NS_ASSUME_NONNULL_BEGIN
35
36 /*!
37  @abstract Indicates which local files WebKit can access when loading content.
38  @discussion If NSReadAccessURLDocumentOption references a single file, only that file may be
39  loaded by WebKit. If NSReadAccessURLDocumentOption references a directory, files inside that
40  directory may be loaded by WebKit.
41 */
42 WK_EXTERN NSAttributedStringDocumentReadingOptionKey const NSReadAccessURLDocumentOption
43     NS_SWIFT_NAME(NSAttributedStringDocumentReadingOptionKey.readAccessURL) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
44
45 /*!
46  @abstract Type definition for the completion handler block used to get asynchronous attributed strings.
47  @discussion The completion handler block is passed the attributed string result along with any
48  document-level attributes, like NSBackgroundColorDocumentAttribute, or an error. An implementation
49  of this block type must expect to be called asynchronously when passed to HTML loading methods.
50 */
51 typedef void (^NSAttributedStringCompletionHandler)(NSAttributedString * _Nullable, NSDictionary<NSAttributedStringDocumentAttributeKey, id> * _Nullable, NSError * _Nullable)
52     NS_SWIFT_NAME(NSAttributedString.CompletionHandler) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
53
54 /*!
55  @discussion Extension of @link //apple_ref/occ/NSAttributedString NSAttributedString @/link to
56  create attributed strings from HTML content using WebKit.
57 */
58 @interface NSAttributedString (NSAttributedStringWebKitAdditions)
59
60 /*!
61  @abstract Loads an HTML URL request and converts the contents into an attributed string.
62  @param request The request specifying the URL to load.
63  @param options Document attributes for interpreting the document contents.
64  NSTextSizeMultiplierDocumentOption and NSTimeoutDocumentOption are supported option keys.
65  @param completionHandler A block to invoke when the operation completes or fails.
66  @discussion The completionHandler is passed the attributed string result along with any
67  document-level attributes, or an error.
68 */
69 + (void)loadFromHTMLWithRequest:(NSURLRequest *)request options:(NSDictionary<NSAttributedStringDocumentReadingOptionKey, id> *)options completionHandler:(NSAttributedStringCompletionHandler)completionHandler
70     NS_SWIFT_NAME(loadFromHTML(request:options:completionHandler:)) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
71
72 /*!
73  @abstract Converts a local HTML file into an attributed string.
74  @param fileURL The file URL to load.
75  @param options Document attributes for interpreting the document contents.
76  NSTextSizeMultiplierDocumentOption, NSTimeoutDocumentOption and NSReadAccessURLDocumentOption
77  are supported option keys.
78  @param completionHandler A block to invoke when the operation completes or fails.
79  @discussion The completionHandler is passed the attributed string result along with any
80  document-level attributes, or an error. If NSReadAccessURLDocumentOption references a single file,
81  only that file may be loaded by WebKit. If NSReadAccessURLDocumentOption references a directory,
82  files inside that directory may be loaded by WebKit.
83 */
84 + (void)loadFromHTMLWithFileURL:(NSURL *)fileURL options:(NSDictionary<NSAttributedStringDocumentReadingOptionKey, id> *)options completionHandler:(NSAttributedStringCompletionHandler)completionHandler
85     NS_SWIFT_NAME(loadFromHTML(fileURL:options:completionHandler:)) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
86
87 /*!
88  @abstract Converts an HTML string into an attributed string.
89  @param string The HTML string to use as the contents.
90  @param options Document attributes for interpreting the document contents.
91  NSTextSizeMultiplierDocumentOption, NSTimeoutDocumentOption and NSBaseURLDocumentOption
92  are supported option keys.
93  @param completionHandler A block to invoke when the operation completes or fails.
94  @discussion The completionHandler is passed the attributed string result along with any
95  document-level attributes, or an error. NSBaseURLDocumentOption is used to resolve relative URLs
96  within the document.
97 */
98 + (void)loadFromHTMLWithString:(NSString *)string options:(NSDictionary<NSAttributedStringDocumentReadingOptionKey, id> *)options completionHandler:(NSAttributedStringCompletionHandler)completionHandler
99     NS_SWIFT_NAME(loadFromHTML(string:options:completionHandler:)) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
100
101 /*!
102  @abstract Converts HTML data into an attributed string.
103  @param data The HTML data to use as the contents.
104  @param options Document attributes for interpreting the document contents.
105  NSTextSizeMultiplierDocumentOption, NSTimeoutDocumentOption, NSTextEncodingNameDocumentOption,
106  and NSCharacterEncodingDocumentOption are supported option keys.
107  @param completionHandler A block to invoke when the operation completes or fails.
108  @discussion The completionHandler is passed the attributed string result along with any
109  document-level attributes, or an error. If neither NSTextEncodingNameDocumentOption nor
110  NSCharacterEncodingDocumentOption is supplied, a best-guess encoding is used.
111 */
112 + (void)loadFromHTMLWithData:(NSData *)data options:(NSDictionary<NSAttributedStringDocumentReadingOptionKey, id> *)options completionHandler:(NSAttributedStringCompletionHandler)completionHandler
113     NS_SWIFT_NAME(loadFromHTML(data:options:completionHandler:)) WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
114
115 @end
116
117 NS_ASSUME_NONNULL_END