Always show the arrow for text selection services
[WebKit-https.git] / Source / WebCore / platform / spi / mac / DataDetectorsSPI.h
1 /*
2  * Copyright (C) 2014 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 #import "SoftLinking.h"
27 #import <objc/runtime.h>
28
29 // FIXME: This header should include various DataDetectors SPI headers if using the internal SDK.
30
31 typedef struct __DDScanner DDScanner, *DDScannerRef;
32 typedef struct __DDScanQuery *DDScanQueryRef;
33 typedef struct __DDResult *DDResultRef;
34 typedef struct __DDHighlight DDHighlight, *DDHighlightRef;
35
36 typedef enum {
37     DDScannerTypeStandard = 0,
38 } DDScannerType;
39
40 enum {
41     DDScannerOptionStopAtFirstMatch = 1,
42 };
43 typedef CFIndex DDScannerOptions;
44
45 enum {
46     DDScannerCopyResultsOptionsNone = 0,
47     DDScannerCopyResultsOptionsNoOverlap = 1 << 0,
48 };
49 typedef CFIndex DDScannerCopyResultsOptions;
50
51 SOFT_LINK_PRIVATE_FRAMEWORK_OPTIONAL(DataDetectors)
52 SOFT_LINK_PRIVATE_FRAMEWORK_OPTIONAL(DataDetectorsCore)
53
54 extern "C" {
55
56 SOFT_LINK(DataDetectorsCore, DDScannerCreate, DDScannerRef, (DDScannerType type, DDScannerOptions options, CFErrorRef* errorRef), (type, options, errorRef))
57 SOFT_LINK(DataDetectorsCore, DDScanQueryCreateFromString, DDScanQueryRef, (CFAllocatorRef allocator, CFStringRef string, CFRange range), (allocator, string, range))
58 SOFT_LINK(DataDetectorsCore, DDScannerScanQuery, DDScanQueryRef, (DDScannerRef scanner, DDScanQueryRef query), (scanner, query))
59 SOFT_LINK(DataDetectorsCore, DDScannerCopyResultsWithOptions, CFArrayRef, (DDScannerRef scanner, DDScannerCopyResultsOptions options), (scanner, options))
60 SOFT_LINK(DataDetectorsCore, DDResultGetRange, CFRange, (DDResultRef result), (result))
61 SOFT_LINK(DataDetectorsCore, DDResultGetType, CFStringRef, (DDResultRef result), (result))
62
63 }
64
65 #if PLATFORM(MAC)
66 SOFT_LINK_CLASS(DataDetectors, DDActionContext)
67
68 @interface DDActionContext : NSObject <NSCopying, NSSecureCoding>
69
70 @property NSRect highlightFrame;
71 @property (retain) NSArray *allResults;
72 @property (retain) __attribute__((NSObject)) DDResultRef mainResult;
73 @property (assign) BOOL altMode;
74
75 - (DDActionContext *)contextForView:(NSView *)view altMode:(BOOL)altMode interactionStartedHandler:(void (^)(void))interactionStartedHandler interactionChangedHandler:(void (^)(void))interactionChangedHandler interactionStoppedHandler:(void (^)(void))interactionStoppedHandler;
76
77 @end
78
79 enum {
80     DDHighlightStyleBubbleNone = 0,
81     DDHighlightStyleBubbleStandard = 1
82 };
83
84 enum {
85     DDHighlightStyleIconNone = (0 << 16),
86     DDHighlightStyleStandardIconArrow = (1 << 16)
87 };
88
89 enum {
90     DDHighlightStyleButtonShowAlways  = (1 << 24),
91 };
92
93 typedef NSUInteger DDHighlightStyle;
94 #endif
95
96 SOFT_LINK_CLASS(DataDetectors, DDActionsManager)
97
98 @interface DDActionsManager : NSObject
99
100 + (DDActionsManager *)sharedManager;
101 - (NSArray *)menuItemsForResult:(DDResultRef)result actionContext:(DDActionContext *)context;
102 - (NSArray *)menuItemsForTargetURL:(NSString *)targetURL actionContext:(DDActionContext *)context;
103 - (void)requestBubbleClosureUnanchorOnFailure:(BOOL)unanchorOnFailure;
104
105 + (BOOL)shouldUseActionsWithContext:(DDActionContext *)context;
106 + (void)didUseActions;
107
108 - (BOOL)hasActionsForResult:(DDResultRef)result actionContext:(DDActionContext *)actionContext;
109
110 @end