1/*
2 * Copyright (C) 2013 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#ifndef WKPagePolicyClient_h
27#define WKPagePolicyClient_h
28
29#include <WebKit/WKBase.h>
30#include <WebKit/WKEvent.h>
31#include <WebKit/WKPageLoadTypes.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37typedef void (*WKPageDecidePolicyForNavigationActionCallback)(WKPageRef page, WKFrameRef frame, WKFrameNavigationType navigationType, WKEventModifiers modifiers, WKEventMouseButton mouseButton, WKFrameRef originatingFrame, WKURLRequestRef request, WKFramePolicyListenerRef listener, WKTypeRef userData, const void* clientInfo);
38typedef void (*WKPageDecidePolicyForNewWindowActionCallback)(WKPageRef page, WKFrameRef frame, WKFrameNavigationType navigationType, WKEventModifiers modifiers, WKEventMouseButton mouseButton, WKURLRequestRef request, WKStringRef frameName, WKFramePolicyListenerRef listener, WKTypeRef userData, const void* clientInfo);
39typedef void (*WKPageDecidePolicyForResponseCallback_deprecatedForUseWithV0)(WKPageRef page, WKFrameRef frame, WKURLResponseRef response, WKURLRequestRef request, WKFramePolicyListenerRef listener, WKTypeRef userData, const void* clientInfo);
40typedef void (*WKPageUnableToImplementPolicyCallback)(WKPageRef page, WKFrameRef frame, WKErrorRef error, WKTypeRef userData, const void* clientInfo);
41
42typedef void (*WKPageDecidePolicyForNavigationActionCallback_deprecatedForUseWithV0)(WKPageRef page, WKFrameRef frame, WKFrameNavigationType navigationType, WKEventModifiers modifiers, WKEventMouseButton mouseButton, WKURLRequestRef request, WKFramePolicyListenerRef listener, WKTypeRef userData, const void* clientInfo);
43typedef void (*WKPageDecidePolicyForResponseCallback)(WKPageRef page, WKFrameRef frame, WKURLResponseRef response, WKURLRequestRef request, bool canShowMIMEType, WKFramePolicyListenerRef listener, WKTypeRef userData, const void* clientInfo);
44
45typedef struct WKPagePolicyClientBase {
46    int                                                                  version;
47    const void *                                                         clientInfo;
48} WKPagePolicyClientBase;
49
50typedef struct WKPagePolicyClientV0 {
51    WKPagePolicyClientBase                                               base;
52
53    // Version 0.
54    WKPageDecidePolicyForNavigationActionCallback_deprecatedForUseWithV0 decidePolicyForNavigationAction_deprecatedForUseWithV0;
55    WKPageDecidePolicyForNewWindowActionCallback                         decidePolicyForNewWindowAction;
56    WKPageDecidePolicyForResponseCallback_deprecatedForUseWithV0         decidePolicyForResponse_deprecatedForUseWithV0;
57    WKPageUnableToImplementPolicyCallback                                unableToImplementPolicy;
58} WKPagePolicyClientV0;
59
60typedef struct WKPagePolicyClientV1 {
61    WKPagePolicyClientBase                                               base;
62
63    // Version 0.
64    WKPageDecidePolicyForNavigationActionCallback_deprecatedForUseWithV0 decidePolicyForNavigationAction_deprecatedForUseWithV0;
65    WKPageDecidePolicyForNewWindowActionCallback                         decidePolicyForNewWindowAction;
66    WKPageDecidePolicyForResponseCallback_deprecatedForUseWithV0         decidePolicyForResponse_deprecatedForUseWithV0;
67    WKPageUnableToImplementPolicyCallback                                unableToImplementPolicy;
68
69    // Version 1.
70    WKPageDecidePolicyForNavigationActionCallback                        decidePolicyForNavigationAction;
71    WKPageDecidePolicyForResponseCallback                                decidePolicyForResponse;
72} WKPagePolicyClientV1;
73
74// FIXME: These should be deprecated.
75enum { kWKPagePolicyClientCurrentVersion WK_ENUM_DEPRECATED("Use an explicit version number instead") = 1 };
76typedef struct WKPagePolicyClient {
77    int                                                                  version;
78    const void *                                                         clientInfo;
79
80    // Version 0.
81    WKPageDecidePolicyForNavigationActionCallback_deprecatedForUseWithV0 decidePolicyForNavigationAction_deprecatedForUseWithV0;
82    WKPageDecidePolicyForNewWindowActionCallback                         decidePolicyForNewWindowAction;
83    WKPageDecidePolicyForResponseCallback_deprecatedForUseWithV0         decidePolicyForResponse_deprecatedForUseWithV0;
84    WKPageUnableToImplementPolicyCallback                                unableToImplementPolicy;
85
86    // Version 1.
87    WKPageDecidePolicyForNavigationActionCallback                        decidePolicyForNavigationAction;
88    WKPageDecidePolicyForResponseCallback                                decidePolicyForResponse;
89} WKPagePolicyClient;
90
91#ifdef __cplusplus
92}
93#endif
94
95#endif // WKPagePolicyClient_h
96