Add WK_ARRAY and WK_SET annotations
[WebKit-https.git] / Source / WebKit2 / Shared / API / Cocoa / WKFoundation.h
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 #import <Availability.h>
27 #import <CoreFoundation/CoreFoundation.h>
28 #import <TargetConditionals.h>
29
30 #if !defined(WK_API_ENABLED)
31 #if TARGET_OS_IPHONE
32 #define WK_API_ENABLED 1
33 #else
34 #define WK_API_ENABLED (defined(__clang__) && defined(__APPLE__) && !defined(__i386__))
35 #endif
36 #endif
37
38 #ifdef __cplusplus
39 #define WK_EXTERN extern "C" __attribute__((visibility ("default")))
40 #else
41 #define WK_EXTERN extern __attribute__((visibility ("default")))
42 #endif
43
44 #ifdef WK_FRAMEWORK_HEADER_POSTPROCESSING_ENABLED
45 // Do not remove or change this comment. POSTPROCESSING_INSERTS_DEPLOYMENT_TARGET_AVAILABILITY_DEFINITION_HERE
46 #endif
47
48 #ifndef WK_FRAMEWORK_HEADER_POSTPROCESSING_ENABLED
49
50 #define WK_AVAILABLE(_mac, _ios)
51 #define WK_CLASS_AVAILABLE(_mac, _ios) __attribute__((visibility ("default")))
52 #define WK_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...) __attribute__((deprecated(__VA_ARGS__)))
53 #define WK_CLASS_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...) __attribute__((visibility("default"))) __attribute__((deprecated(__VA_ARGS__)))
54 #define WK_ENUM_AVAILABLE(_mac, _ios)
55 #define WK_ENUM_AVAILABLE_IOS(_ios)
56
57 #define WK_ARRAY(...) NSArray
58 #define WK_SET(...) NSSet
59
60 #ifndef __NSi_8_3
61 #define __NSi_8_3 introduced=8.3
62 #endif
63
64 #ifdef __OBJC__
65 #import <Foundation/Foundation.h>
66
67 #ifdef NS_DESIGNATED_INITIALIZER
68 #define WK_DESIGNATED_INITIALIZER NS_DESIGNATED_INITIALIZER
69 #else
70 #define WK_DESIGNATED_INITIALIZER
71 #endif
72
73 #ifdef NS_UNAVAILABLE
74 #define WK_UNAVAILABLE NS_UNAVAILABLE
75 #else
76 #define WK_UNAVAILABLE
77 #endif
78
79 #if __has_feature(assume_nonnull)
80
81 #ifdef NS_ASSUME_NONNULL_BEGIN
82 #define WK_ASSUME_NONNULL_BEGIN NS_ASSUME_NONNULL_BEGIN
83 #else
84 #define WK_ASSUME_NONNULL_BEGIN _Pragma("clang assume_nonnull begin")
85 #endif
86
87 #ifdef NS_ASSUME_NONNULL_END
88 #define WK_ASSUME_NONNULL_END NS_ASSUME_NONNULL_END
89 #else
90 #define WK_ASSUME_NONNULL_END _Pragma("clang assume_nonnull end")
91 #endif
92
93 #define WK_NULLABLE nullable
94 #define WK_NULL_UNSPECIFIED null_unspecified
95 #define WK_NULLABLE_SPECIFIER __nullable
96 #define WK_NULLABLE_PROPERTY nullable,
97
98 #else
99
100 #define WK_ASSUME_NONNULL_BEGIN
101 #define WK_ASSUME_NONNULL_END
102
103 #define WK_NULLABLE
104 #define WK_NULL_UNSPECIFIED
105 #define WK_NULLABLE_SPECIFIER
106 #define WK_NULLABLE_PROPERTY
107
108 #endif
109
110 #if defined(__MAC_OS_X_VERSION_MAX_ALLOWED) && __MAC_OS_X_VERSION_MAX_ALLOWED < 101000
111 typedef NSUInteger NSEventModifierFlags;
112 #endif
113
114 #endif
115
116 #endif