Tools/TestWebKitAPI/Helpers/cocoa/TestContextMenuDriver.h

/*
 * 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.
 */

#ifdef __cplusplus

#if USE(UICONTEXTMENU)

#import <wtf/WeakObjCPtr.h>

#if USE(APPLE_INTERNAL_SDK)
#import <UIKit/_UIClickInteractionDriving.h>
#import <UIKit/UIEvent_Private.h>
#else

typedef NS_ENUM(NSUInteger, _UIInputPrecision) {
    _UIInputPrecisionUnknown,
    _UIInputPrecisionLow,
    _UIInputPrecisionHigh,
};

@protocol _UIClickInteractionDriverDelegate;
@protocol _UIClickInteractionDriving <NSObject>
@property (nonatomic, weak) id<_UIClickInteractionDriverDelegate> delegate;
@end

#endif

@interface TestContextMenuDriver : NSObject <_UIClickInteractionDriving> {
    WeakObjCPtr<id<_UIClickInteractionDriverDelegate>> _delegate;
    WeakObjCPtr<UIView> _view;
    CGFloat _allowableMovement;
    RetainPtr<UIGestureRecognizer> _primaryGestureRecognizer;
    NSTimeInterval _touchDuration;
    BOOL _cancelsTouchesInView;
}

@property (nonatomic, class, readonly) BOOL requiresForceCapability;
@property (nonatomic, readonly) BOOL hasExceededAllowableMovement;
@property (nonatomic, readonly) BOOL isCurrentlyAcceleratedByForce;
@property (nonatomic, readonly) BOOL clicksUpAutomaticallyAfterTimeout;
@property (nonatomic, readonly) CGFloat maximumEffectProgress;
@property (nonatomic, readonly) _UIInputPrecision inputPrecision;

- (void)begin:(void(^)(BOOL))completionHandler;
- (void)clickDown;
- (void)clickUp;
- (void)end;
+ (BOOL)prefersCancelsTouchesInView;
@end

#endif // USE(UICONTEXTMENU)

#endif // __cplusplus