Soft linking to Reveal framework should be optional
[WebKit-https.git] / Source / WebCore / PAL / pal / spi / cocoa / RevealSPI.h
1 /*
2  * Copyright (C) 2018 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import <objc/runtime.h>
27 #if PLATFORM(MAC)
28 #import <pal/spi/mac/NSImmediateActionGestureRecognizerSPI.h>
29 #endif // PLATFORM(MAC)
30 #import <wtf/SoftLinking.h>
31
32 #if ENABLE(REVEAL)
33
34 #if USE(APPLE_INTERNAL_SDK)
35
36 #if PLATFORM(MAC)
37 #import <Reveal/RVPresenter.h>
38 #import <Reveal/Reveal.h>
39 #endif // PLATFORM(MAC)
40 #import <RevealCore/RVItem_Private.h>
41 #import <RevealCore/RVSelection.h>
42 #import <RevealCore/RevealCore.h>
43 #else // USE(APPLE_INTERNAL_SDK)
44
45
46 @protocol RVPresenterHighlightDelegate;
47
48 @interface RVItem : NSObject <NSSecureCoding>
49 - (instancetype)initWithText:(NSString *)text selectedRange:(NSRange)selectedRange NS_DESIGNATED_INITIALIZER;
50 @end
51
52 @interface RVSelection : NSObject
53 + (NSRange)revealRangeAtIndex:(NSUInteger)clickIndex selectedRanges:(NSArray <NSValue *> *)selectedRanges shouldUpdateSelection:(BOOL *)shouldUpdateSelection;
54 @end
55
56 #if PLATFORM(MAC)
57 @interface RVPresentingContext : NSObject
58 - (instancetype)initWithPointerLocationInView:(NSPoint)pointerLocationInView inView:(NSView *)view highlightDelegate:(id<RVPresenterHighlightDelegate>)highlightDelegate;
59 @end
60 #endif
61
62 @protocol RVPresenterHighlightDelegate <NSObject>
63 @required
64 - (NSArray <NSValue *> *)revealContext:(RVPresentingContext *)context rectsForItem:(RVItem *)item;
65 @optional
66 - (void)revealContext:(RVPresentingContext *)context stopHighlightingItem:(RVItem *)item;
67 - (void)revealContext:(RVPresentingContext *)context drawRectsForItem:(RVItem *)item;
68 @end
69
70 @interface RVDocumentContext : NSObject < NSSecureCoding >
71 @end
72
73 @interface RVPresenter : NSObject
74 #if PLATFORM(MAC)
75 - (id<NSImmediateActionAnimationController>)animationControllerForItem:(RVItem *)item documentContext:(RVDocumentContext *)documentContext presentingContext:(RVPresentingContext *)presentingContext options:(NSDictionary *)options;
76 #endif // PLATFORM(MAC)
77 - (BOOL)revealItem:(RVItem *)item documentContext:(RVDocumentContext *)documentContext presentingContext:(RVPresentingContext *)presentingContext options:(NSDictionary *)options;
78 @end
79
80 #endif // !USE(APPLE_INTERNAL_SDK)
81
82 #endif // ENABLE(REVEAL)