/* * Copyright (C) 2019 Apple Inc. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. */ #import "config.h" #if PLATFORM(IOS_FAMILY) && HAVE(UI_WK_DOCUMENT_CONTEXT) #import "PlatformUtilities.h" #import "Test.h" #import "TestNavigationDelegate.h" #import "TestWKWebView.h" #import "UIKitSPI.h" #import #import #import #import #import #define EXPECT_NSSTRING_EQ(expected, actual) \ EXPECT_TRUE([actual isKindOfClass:[NSString class]]); \ EXPECT_WK_STREQ(expected, (NSString *)actual); #define EXPECT_ATTRIBUTED_STRING_EQ(expected, actual) \ EXPECT_TRUE([actual isKindOfClass:[NSAttributedString class]]); \ EXPECT_WK_STREQ(expected, [(NSAttributedString *)actual string]); #define EXPECT_RECT_EQ(xExpected, yExpected, widthExpected, heightExpected, rect) \ EXPECT_DOUBLE_EQ(xExpected, rect.origin.x); \ EXPECT_DOUBLE_EQ(yExpected, rect.origin.y); \ EXPECT_DOUBLE_EQ(widthExpected, rect.size.width); \ EXPECT_DOUBLE_EQ(heightExpected, rect.size.height); @interface WKContentView () - (void)requestDocumentContext:(UIWKDocumentRequest *)request completionHandler:(void (^)(UIWKDocumentContext *))completionHandler; - (void)adjustSelectionWithDelta:(NSRange)deltaRange completionHandler:(void (^)(void))completionHandler; @end static UIWKDocumentRequest *makeRequest(UIWKDocumentRequestFlags flags, UITextGranularity granularity, NSInteger granularityCount, CGRect documentRect = CGRectZero, id inputElementIdentifier = nil) { auto request = adoptNS([[UIWKDocumentRequest alloc] init]); [request setFlags:flags]; [request setSurroundingGranularity:granularity]; [request setGranularityCount:granularityCount]; [request setDocumentRect:documentRect]; [request setInputElementIdentifier:inputElementIdentifier]; return request.autorelease(); } @implementation TestWKWebView (SynchronousDocumentContext) - (UIWKDocumentContext *)synchronouslyRequestDocumentContext:(UIWKDocumentRequest *)request { __block bool finished = false; __block RetainPtr result; [[self wkContentView] requestDocumentContext:request completionHandler:^(UIWKDocumentContext *context) { result = context; finished = true; }]; TestWebKitAPI::Util::run(&finished); return result.autorelease(); } - (void)synchronouslyAdjustSelectionWithDelta:(NSRange)range { __block bool finished = false; [[self wkContentView] adjustSelectionWithDelta:range completionHandler:^() { finished = true; }]; TestWebKitAPI::Util::run(&finished); } - (NSArray<_WKTextInputContext *> *)synchronouslyRequestTextInputContextsInRect:(CGRect)rect { __block bool finished = false; __block RetainPtr> result; [self _requestTextInputContextsInRect:rect completionHandler:^(NSArray<_WKTextInputContext *> *contexts) { result = contexts; finished = true; }]; TestWebKitAPI::Util::run(&finished); return result.autorelease(); } @end static NSString *applyStyle(NSString *HTMLString) { return [@"" stringByAppendingString:HTMLString]; } static NSString *applyAhemStyle(NSString *HTMLString) { return [@"" stringByAppendingString:HTMLString]; } TEST(WebKit, DocumentEditingContext) { RetainPtr webView = adoptNS([[TestWKWebView alloc] initWithFrame:NSMakeRect(0, 0, 800, 600)]); UIWKDocumentContext *context; [webView synchronouslyLoadHTMLString:applyStyle(@"The quick brown fox jumps over the lazy dog.")]; [webView stringByEvaluatingJavaScript:@"getSelection().setBaseAndExtent(jumps, 0, jumps, 1)"]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityWord, 1)]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("fox ", context.contextBefore); EXPECT_NSSTRING_EQ("jumps", context.selectedText); EXPECT_NSSTRING_EQ(" over", context.contextAfter); context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityWord, 2)]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("brown fox ", context.contextBefore); EXPECT_NSSTRING_EQ("jumps", context.selectedText); EXPECT_NSSTRING_EQ(" over the", context.contextAfter); context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityParagraph, 1)]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("The quick brown fox ", context.contextBefore); EXPECT_NSSTRING_EQ("jumps", context.selectedText); EXPECT_NSSTRING_EQ(" over the lazy dog.", context.contextAfter); // Attributed strings. // FIXME: Currently we don't test the attributes... because we don't set any. context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestAttributed, UITextGranularityWord, 1)]; EXPECT_NOT_NULL(context); EXPECT_ATTRIBUTED_STRING_EQ("fox ", context.contextBefore); EXPECT_ATTRIBUTED_STRING_EQ("jumps", context.selectedText); EXPECT_ATTRIBUTED_STRING_EQ(" over", context.contextAfter); // Extremities of the document. [webView stringByEvaluatingJavaScript:@"getSelection().setBaseAndExtent(the, 0, the, 1)"]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityWord, 1)]; EXPECT_NOT_NULL(context); EXPECT_NULL(context.contextBefore); EXPECT_NSSTRING_EQ("The", context.selectedText); EXPECT_NSSTRING_EQ(" quick", context.contextAfter); [webView stringByEvaluatingJavaScript:@"getSelection().setBaseAndExtent(dog, 0, dog, 1)"]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularitySentence, 1)]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("The quick brown fox jumps over the lazy ", context.contextBefore); EXPECT_NSSTRING_EQ("dog.", context.selectedText); EXPECT_NULL(context.contextAfter); // Spatial requests. context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText | UIWKDocumentRequestSpatial, UITextGranularityWord, 1, CGRectMake(0, 0, 10, 10))]; EXPECT_NOT_NULL(context); EXPECT_NULL(context.contextBefore); EXPECT_NULL(context.selectedText); EXPECT_NSSTRING_EQ("The quick", context.contextAfter); context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText | UIWKDocumentRequestSpatial, UITextGranularityWord, 1, CGRectMake(0, 0, 800, 600))]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("The quick brown fox jumps over the lazy ", context.contextBefore); EXPECT_NSSTRING_EQ("dog.", context.selectedText); EXPECT_NULL(context.contextAfter); [webView stringByEvaluatingJavaScript:@"getSelection().removeAllRanges()"]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText | UIWKDocumentRequestSpatial, UITextGranularityWord, 1, CGRectMake(0, 0, 800, 600))]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("The quick brown fox ", context.contextBefore); EXPECT_NULL(context.selectedText); EXPECT_NSSTRING_EQ("jumps over the lazy dog.", context.contextAfter); // Selection adjustment. [webView stringByEvaluatingJavaScript:@"getSelection().setBaseAndExtent(jumps, 0, jumps, 1)"]; [webView synchronouslyAdjustSelectionWithDelta:NSMakeRange(6, -1)]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityWord, 1)]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("over", context.selectedText); [webView synchronouslyAdjustSelectionWithDelta:NSMakeRange(-6, 1)]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityWord, 1)]; EXPECT_NOT_NULL(context); EXPECT_NSSTRING_EQ("jumps", context.selectedText); // Text rects. [webView synchronouslyLoadHTMLString:applyAhemStyle(@"MMMM MMM MM M")]; [webView stringByEvaluatingJavaScript:@"getSelection().setBaseAndExtent(four, 0, four, 1)"]; context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText | UIWKDocumentRequestRects, UITextGranularityWord, 0)]; EXPECT_NOT_NULL(context); EXPECT_NULL(context.contextBefore); EXPECT_NSSTRING_EQ("MMMM", context.selectedText); EXPECT_NULL(context.contextAfter); NSArray *rects = [[context characterRectsForCharacterRange:NSMakeRange(0, 4)] sortedArrayUsingComparator:^(NSValue *a, NSValue *b) { return [@(a.CGRectValue.origin.x) compare:@(b.CGRectValue.origin.x)]; }]; EXPECT_EQ(4UL, rects.count); EXPECT_RECT_EQ(0, 0, 23, 24, rects[0].CGRectValue); EXPECT_RECT_EQ(23, 0, 23, 24, rects[1].CGRectValue); EXPECT_RECT_EQ(46, 0, 23, 24, rects[2].CGRectValue); EXPECT_RECT_EQ(69, 0, 23, 24, rects[3].CGRectValue); rects = [context characterRectsForCharacterRange:NSMakeRange(5, 1)]; EXPECT_EQ(0UL, rects.count); context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText | UIWKDocumentRequestRects, UITextGranularityWord, 1)]; EXPECT_NSSTRING_EQ(" MMM", context.contextAfter); rects = [context characterRectsForCharacterRange:NSMakeRange(0, 1)]; EXPECT_EQ(1UL, rects.count); EXPECT_RECT_EQ(0, 0, 23, 24, rects.firstObject.CGRectValue); rects = [context characterRectsForCharacterRange:NSMakeRange(6, 1)]; EXPECT_EQ(1UL, rects.count); EXPECT_RECT_EQ(138, 0, 23, 24, rects.firstObject.CGRectValue); // Text Input Context [webView synchronouslyLoadHTMLString:applyStyle(@"")]; NSArray<_WKTextInputContext *> *textInputContexts = [webView synchronouslyRequestTextInputContextsInRect:[webView frame]]; EXPECT_EQ(1UL, textInputContexts.count); EXPECT_RECT_EQ(0, 0, 50, 50, textInputContexts[0].boundingRect); context = [webView synchronouslyRequestDocumentContext:makeRequest(UIWKDocumentRequestText, UITextGranularityWord, 0, CGRectZero, textInputContexts[0])]; EXPECT_NSSTRING_EQ("hello,", context.contextBefore); EXPECT_NULL(context.selectedText); EXPECT_NSSTRING_EQ(" world", context.contextAfter); } #endif // PLATFORM(IOS_FAMILY) && HAVE(UI_WK_DOCUMENT_CONTEXT)