[iOS WK2] Add plumbing for WKContentView to ask the web process for additional drag...
[WebKit-https.git] / Tools / TestWebKitAPI / ios / DataInteractionSimulator.h
1 /*
2  * Copyright (C) 2017 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 #pragma once
27
28 #if ENABLE(DATA_INTERACTION)
29
30 #import "TestWKWebView.h"
31 #import <UIKit/NSItemProvider+UIKitAdditions.h>
32
33 #if USE(APPLE_INTERNAL_SDK)
34 #import <UIKit/NSString+UIItemProvider.h>
35 #import <UIKit/NSURL+UIItemProvider.h>
36 #import <UIKit/UIImage+UIItemProvider.h>
37 #import <UIKit/UIItemProvider.h>
38 #import <UIKit/UIItemProvider_Private.h>
39 #else
40
41 @interface NSURL ()
42 @property (nonatomic, copy, setter=_setTitle:) NSString *_title;
43 @end
44
45 #define UIItemProviderRepresentationOptionsVisibilityAll NSItemProviderRepresentationVisibilityAll
46
47 @protocol UIItemProviderReading <NSItemProviderReading>
48
49 @required
50 - (instancetype)initWithItemProviderData:(NSData *)data typeIdentifier:(NSString *)typeIdentifier error:(NSError **)outError;
51
52 @end
53
54 @protocol UIItemProviderWriting <NSItemProviderWriting>
55
56 @required
57 - (NSProgress *)loadDataWithTypeIdentifier:(NSString *)typeIdentifier forItemProviderCompletionHandler:(void (^)(NSData *, NSError *))completionHandler;
58
59 @end
60
61 @interface NSAttributedString () <UIItemProviderReading, UIItemProviderWriting>
62 @end
63 @interface NSString () <UIItemProviderReading, UIItemProviderWriting>
64 @end
65 @interface NSURL () <UIItemProviderReading, UIItemProviderWriting>
66 @end
67 @interface UIImage () <UIItemProviderReading, UIItemProviderWriting>
68 @end
69
70 @interface UIItemProvider : NSItemProvider
71 @end
72
73 #endif
74
75 #import <UIKit/UIKit.h>
76 #import <WebKit/WKUIDelegatePrivate.h>
77 #import <WebKit/_WKInputDelegate.h>
78 #import <wtf/BlockPtr.h>
79
80 @class MockDataOperationSession;
81 @class MockDataInteractionSession;
82
83 extern NSString * const DataInteractionEnterEventName;
84 extern NSString * const DataInteractionOverEventName;
85 extern NSString * const DataInteractionPerformOperationEventName;
86 extern NSString * const DataInteractionLeaveEventName;
87 extern NSString * const DataInteractionStartEventName;
88
89 typedef NSDictionary<NSNumber *, NSValue *> *ProgressToCGPointValueMap;
90
91 typedef NS_ENUM(NSInteger, DataInteractionPhase) {
92     DataInteractionCancelled = 0,
93     DataInteractionBeginning = 1,
94     DataInteractionBegan = 2,
95     DataInteractionEntered = 3,
96     DataInteractionPerforming = 4
97 };
98
99 @interface DataInteractionSimulator : NSObject<WKUIDelegatePrivate, _WKInputDelegate> {
100 @private
101     RetainPtr<TestWKWebView> _webView;
102     RetainPtr<MockDataInteractionSession> _dataInteractionSession;
103     RetainPtr<MockDataOperationSession> _dataOperationSession;
104     RetainPtr<NSMutableArray> _observedEventNames;
105     RetainPtr<NSArray> _externalItemProviders;
106     RetainPtr<NSArray *> _sourceItemProviders;
107     RetainPtr<NSArray *> _finalSelectionRects;
108     CGPoint _startLocation;
109     CGPoint _endLocation;
110     CGRect _lastKnownDragCaretRect;
111
112     RetainPtr<NSMutableDictionary<NSNumber *, NSValue *>>_remainingAdditionalItemRequestLocationsByProgress;
113     RetainPtr<NSMutableArray<NSValue *>>_queuedAdditionalItemRequestLocations;
114
115     bool _isDoneWaitingForInputSession;
116     BOOL _shouldPerformOperation;
117     double _currentProgress;
118     bool _isDoneWithCurrentRun;
119     DataInteractionPhase _phase;
120 }
121
122 - (instancetype)initWithWebView:(TestWKWebView *)webView;
123 // The start location, end location, and locations of additional item requests are all in window coordinates.
124 - (void)runFrom:(CGPoint)startLocation to:(CGPoint)endLocation;
125 - (void)runFrom:(CGPoint)startLocation to:(CGPoint)endLocation additionalItemRequestLocations:(ProgressToCGPointValueMap)additionalItemRequestLocations;
126 - (void)waitForInputSession;
127
128 @property (nonatomic) BOOL allowsFocusToStartInputSession;
129 @property (nonatomic) BOOL shouldEnsureUIApplication;
130 @property (nonatomic) BOOL shouldAllowMoveOperation;
131 @property (nonatomic) BlockPtr<BOOL(_WKActivatedElementInfo *)> showCustomActionSheetBlock;
132 @property (nonatomic) BlockPtr<NSArray *(UIItemProvider *, NSArray *, NSDictionary *)> convertItemProvidersBlock;
133 @property (nonatomic) BlockPtr<NSArray *(id <UIDropSession>)> overridePerformDropBlock;
134 @property (nonatomic, strong) NSArray *externalItemProviders;
135 @property (nonatomic) BlockPtr<NSUInteger(NSUInteger, id)> overrideDataInteractionOperationBlock;
136 @property (nonatomic) BlockPtr<void(BOOL, NSArray *)> dataInteractionOperationCompletionBlock;
137
138 @property (nonatomic, readonly) NSArray *sourceItemProviders;
139 @property (nonatomic, readonly) NSArray *observedEventNames;
140 @property (nonatomic, readonly) NSArray *finalSelectionRects;
141 @property (nonatomic, readonly) DataInteractionPhase phase;
142 @property (nonatomic, readonly) CGRect lastKnownDragCaretRect;
143
144 @end
145
146 #endif // ENABLE(DATA_INTERACTION)