Fix the build on other platforms after r220865
[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
32 #if USE(APPLE_INTERNAL_SDK)
33 #import <UIKit/NSString+UIItemProvider.h>
34 #import <UIKit/NSURL+UIItemProvider.h>
35 #import <UIKit/UIImage+UIItemProvider.h>
36 #import <UIKit/UIItemProvider.h>
37 #import <UIKit/UIItemProvider_Private.h>
38 #else
39
40 @interface NSURL ()
41 @property (nonatomic, copy, setter=_setTitle:) NSString *_title;
42 @end
43
44 #define UIItemProviderRepresentationOptionsVisibilityAll NSItemProviderRepresentationVisibilityAll
45
46 @protocol UIItemProviderReading <NSItemProviderReading>
47
48 @required
49 - (instancetype)initWithItemProviderData:(NSData *)data typeIdentifier:(NSString *)typeIdentifier error:(NSError **)outError;
50
51 @end
52
53 @protocol UIItemProviderWriting <NSItemProviderWriting>
54
55 @required
56 - (NSProgress *)loadDataWithTypeIdentifier:(NSString *)typeIdentifier forItemProviderCompletionHandler:(void (^)(NSData *, NSError *))completionHandler;
57
58 @end
59
60 @interface NSAttributedString () <UIItemProviderReading, UIItemProviderWriting>
61 @end
62 @interface NSString () <UIItemProviderReading, UIItemProviderWriting>
63 @end
64 @interface NSURL () <UIItemProviderReading, UIItemProviderWriting>
65 @end
66 @interface UIImage () <UIItemProviderReading, UIItemProviderWriting>
67 @end
68
69 #endif
70
71 #import <UIKit/UIKit.h>
72 #import <WebKit/WKUIDelegatePrivate.h>
73 #import <WebKit/_WKInputDelegate.h>
74 #import <wtf/BlockPtr.h>
75
76 @class MockDataOperationSession;
77 @class MockDataInteractionSession;
78
79 extern NSString * const DataInteractionEnterEventName;
80 extern NSString * const DataInteractionOverEventName;
81 extern NSString * const DataInteractionPerformOperationEventName;
82 extern NSString * const DataInteractionLeaveEventName;
83 extern NSString * const DataInteractionStartEventName;
84
85 typedef NS_ENUM(NSInteger, DataInteractionPhase) {
86     DataInteractionCancelled = 0,
87     DataInteractionBeginning = 1,
88     DataInteractionBegan = 2,
89     DataInteractionEntered = 3,
90     DataInteractionPerforming = 4
91 };
92
93 @interface DataInteractionSimulator : NSObject<WKUIDelegatePrivate, _WKInputDelegate> {
94 @private
95     RetainPtr<TestWKWebView> _webView;
96     RetainPtr<MockDataInteractionSession> _dataInteractionSession;
97     RetainPtr<MockDataOperationSession> _dataOperationSession;
98     RetainPtr<NSMutableArray> _observedEventNames;
99     RetainPtr<NSArray> _externalItemProviders;
100     RetainPtr<NSArray *> _sourceItemProviders;
101     RetainPtr<NSArray *> _finalSelectionRects;
102     CGPoint _startLocation;
103     CGPoint _endLocation;
104     CGRect _lastKnownDragCaretRect;
105
106     bool _isDoneWaitingForInputSession;
107     BOOL _shouldPerformOperation;
108     double _currentProgress;
109     bool _isDoneWithCurrentRun;
110     DataInteractionPhase _phase;
111 }
112
113 - (instancetype)initWithWebView:(TestWKWebView *)webView;
114 - (void)runFrom:(CGPoint)startLocation to:(CGPoint)endLocation;
115 - (void)waitForInputSession;
116
117 @property (nonatomic) BOOL allowsFocusToStartInputSession;
118 @property (nonatomic) BOOL shouldEnsureUIApplication;
119 @property (nonatomic) BOOL shouldAllowMoveOperation;
120 @property (nonatomic) BlockPtr<BOOL(_WKActivatedElementInfo *)> showCustomActionSheetBlock;
121 @property (nonatomic) BlockPtr<NSArray *(UIItemProvider *, NSArray *, NSDictionary *)> convertItemProvidersBlock;
122 @property (nonatomic) BlockPtr<NSArray *(id <UIDropSession>)> overridePerformDropBlock;
123 @property (nonatomic, strong) NSArray *externalItemProviders;
124 @property (nonatomic) BlockPtr<NSUInteger(NSUInteger, id)> overrideDataInteractionOperationBlock;
125 @property (nonatomic) BlockPtr<void(BOOL, NSArray *)> dataInteractionOperationCompletionBlock;
126
127 @property (nonatomic, readonly) NSArray *sourceItemProviders;
128 @property (nonatomic, readonly) NSArray *observedEventNames;
129 @property (nonatomic, readonly) NSArray *finalSelectionRects;
130 @property (nonatomic, readonly) DataInteractionPhase phase;
131 @property (nonatomic, readonly) CGRect lastKnownDragCaretRect;
132
133 @end
134
135 #endif // ENABLE(DATA_INTERACTION)