[Cocoa] Get rid of WK_ macros for nullability
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKUserScript.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 <WebKit/WKFoundation.h>
27
28 #if WK_API_ENABLED
29
30 #import <Foundation/Foundation.h>
31
32 /*! @enum WKUserScriptInjectionTime
33  @abstract when a user script should be injected into a webpage.
34  @constant WKUserScriptInjectionTimeAtDocumentStart    Inject the script after the document element has been created, but before any other content has been loaded.
35  @constant WKUserScriptInjectionTimeAtDocumentEnd      Inject the script after the document has finished loading, but before any subresources may have finished loading.
36  */
37 NS_ASSUME_NONNULL_BEGIN
38
39 typedef NS_ENUM(NSInteger, WKUserScriptInjectionTime) {
40     WKUserScriptInjectionTimeAtDocumentStart,
41     WKUserScriptInjectionTimeAtDocumentEnd
42 } WK_ENUM_AVAILABLE(10_10, 8_0);
43
44 /*! A @link WKUserScript @/link object represents a script that can be injected into webpages.
45  */
46 WK_CLASS_AVAILABLE(10_10, 8_0)
47 @interface WKUserScript : NSObject <NSCopying>
48
49 /* @abstract The script source code. */
50 @property (nonatomic, readonly, copy) NSString *source;
51
52 /* @abstract When the script should be injected. */
53 @property (nonatomic, readonly) WKUserScriptInjectionTime injectionTime;
54
55 /* @abstract Whether the script should be injected into all frames or just the main frame. */
56 @property (nonatomic, readonly, getter=isForMainFrameOnly) BOOL forMainFrameOnly;
57
58 /*! @abstract Returns an initialized user script that can be added to a @link WKUserContentController @/link.
59  @param source The script source.
60  @param injectionTime When the script should be injected.
61  @param forMainFrameOnly Whether the script should be injected into all frames or just the main frame.
62  */
63 - (instancetype)initWithSource:(NSString *)source injectionTime:(WKUserScriptInjectionTime)injectionTime forMainFrameOnly:(BOOL)forMainFrameOnly;
64
65 @end
66
67 NS_ASSUME_NONNULL_END
68
69 #endif