REGRESSION (r176137): iOS build broke after moving DataDetectors scanning code to...
[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 typedef struct __DDScanner DDScanner, *DDScannerRef;
30 typedef struct __DDScanQuery *DDScanQueryRef;
31 typedef struct __DDResult *DDResultRef;
32
33 typedef enum {
34     DDScannerTypeStandard = 0,
35 } DDScannerType;
36
37 enum {
38     DDScannerOptionStopAtFirstMatch = 1,
39 };
40 typedef CFIndex DDScannerOptions;
41
42 enum {
43     DDScannerCopyResultsOptionsNone = 0,
44     DDScannerCopyResultsOptionsNoOverlap = 1 << 0,
45 };
46 typedef CFIndex DDScannerCopyResultsOptions;
47
48 SOFT_LINK_PRIVATE_FRAMEWORK_OPTIONAL(DataDetectors)
49 SOFT_LINK_PRIVATE_FRAMEWORK_OPTIONAL(DataDetectorsCore)
50
51 extern "C" {
52
53 SOFT_LINK(DataDetectorsCore, DDScannerCreate, DDScannerRef, (DDScannerType type, DDScannerOptions options, CFErrorRef* errorRef), (type, options, errorRef))
54 SOFT_LINK(DataDetectorsCore, DDScanQueryCreateFromString, DDScanQueryRef, (CFAllocatorRef allocator, CFStringRef string, CFRange range), (allocator, string, range))
55 SOFT_LINK(DataDetectorsCore, DDScannerScanQuery, DDScanQueryRef, (DDScannerRef scanner, DDScanQueryRef query), (scanner, query))
56 SOFT_LINK(DataDetectorsCore, DDScannerCopyResultsWithOptions, CFArrayRef, (DDScannerRef scanner, DDScannerCopyResultsOptions options), (scanner, options))
57 SOFT_LINK(DataDetectorsCore, DDResultGetRange, CFRange, (DDResultRef result), (result))
58
59 }
60
61 #if PLATFORM(MAC)
62 SOFT_LINK_CLASS(DataDetectors, DDActionContext)
63
64 @interface DDActionContext : NSObject <NSCopying, NSSecureCoding>
65
66 @property NSRect highlightFrame;
67 @property (retain) NSArray *allResults;
68 @property (retain) __attribute__((NSObject)) DDResultRef mainResult;
69 @property (copy) void (^completionHandler)(void);
70 @property (assign) BOOL forActionMenuContent;
71
72 - (DDActionContext *)contextForView:(NSView *)view altMode:(BOOL)altMode interactionStartedHandler:(void (^)(void))interactionStartedHandler interactionChangedHandler:(void (^)(void))interactionChangedHandler interactionStoppedHandler:(void (^)(void))interactionStoppedHandler;
73
74 @end
75 #endif
76
77 SOFT_LINK_CLASS(DataDetectors, DDActionsManager)
78
79 @interface DDActionsManager : NSObject
80
81 + (DDActionsManager *)sharedManager;
82 - (NSArray *)menuItemsForResult:(DDResultRef)result actionContext:(DDActionContext *)context;
83 - (NSArray *)menuItemsForTargetURL:(NSString *)targetURL actionContext:(DDActionContext *)context;
84 - (void)requestBubbleClosureUnanchorOnFailure:(BOOL)unanchorOnFailure;
85
86 + (BOOL)shouldUseActionsWithContext:(DDActionContext *)context;
87 + (void)didUseActions;
88
89
90 @end