blob: 4a3d0520710091ed714e7038dc94cf10e3fface7 [file] [log] [blame]
David 'Digit' Turner23d24392010-12-06 12:05:11 +01001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
Elliott Hughes4aa2e6a2014-05-07 12:37:44 -070028
Elliott Hughesce934e32018-09-06 13:26:08 -070029#pragma once
30
31/**
32 * @file android/api-level.h
33 * @brief Functions and constants for dealing with multiple API levels.
34 */
David 'Digit' Turner23d24392010-12-06 12:05:11 +010035
Elliott Hughes203e13d2016-07-22 14:56:18 -070036#include <sys/cdefs.h>
37
Elliott Hughesc0f46562018-11-09 15:38:52 -080038__BEGIN_DECLS
39
Elliott Hughesce934e32018-09-06 13:26:08 -070040/**
41 * Magic version number for an Android OS build which has
42 * not yet turned into an official release,
Elliott Hughes9823c922019-10-07 20:51:00 +000043 * for comparison against `__ANDROID_API__`.
Elliott Hughesce934e32018-09-06 13:26:08 -070044 */
Dan Albert495ec922016-09-21 01:08:44 -070045#define __ANDROID_API_FUTURE__ 10000
Dan Albert495ec922016-09-21 01:08:44 -070046
Elliott Hughes9823c922019-10-07 20:51:00 +000047/* This #ifndef should never be true except when doxygen is generating docs. */
Josh Gao99739d42016-04-13 17:16:47 -070048#ifndef __ANDROID_API__
Elliott Hughesce934e32018-09-06 13:26:08 -070049/**
50 * `__ANDROID_API__` is the API level being targeted. For the OS,
51 * this is `__ANDROID_API_FUTURE__`. For the NDK, this is set by the
Elliott Hughes9823c922019-10-07 20:51:00 +000052 * compiler system based on the API level you claimed to target.
Elliott Hughesce934e32018-09-06 13:26:08 -070053 */
Dan Albert495ec922016-09-21 01:08:44 -070054#define __ANDROID_API__ __ANDROID_API_FUTURE__
Josh Gao99739d42016-04-13 17:16:47 -070055#endif
David 'Digit' Turner23d24392010-12-06 12:05:11 +010056
Elliott Hughes9823c922019-10-07 20:51:00 +000057#if __ANDROID_API__ != __ANDROID_API_FUTURE__
58/**
59 * `__ANDROID_NDK__` is defined for code that's built by the NDK
60 * rather than as part of the OS. "Built by the NDK" is an ambiguous idea,
61 * so you might prefer to check `__ANDROID__`, `__BIONIC__`, `__linux__`,
62 * or `__NDK_MAJOR__` instead, depending on exactly what you're trying to say.
63 *
64 * `__ANDROID_NDK__` is intended to capture "this code is being built for
65 * Android, but targeting a specific API level". This is true for all code built
66 * by the NDK proper, but also for OS code that sets `sdk_version` in its build
67 * file. This distinction might matter to you if, for example, your code could
68 * be built as part of an app *or* as part of the OS.
69 */
70#define __ANDROID_NDK__ 1
71#endif
72
73/** Names the Gingerbread API level (9), for comparison against `__ANDROID_API__`. */
Elliott Hughes5bc78c82016-11-16 11:35:43 -080074#define __ANDROID_API_G__ 9
Elliott Hughes5bc78c82016-11-16 11:35:43 -080075
Elliott Hughes9823c922019-10-07 20:51:00 +000076/** Names the Ice-Cream Sandwich API level (14), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070077#define __ANDROID_API_I__ 14
78
Elliott Hughes9823c922019-10-07 20:51:00 +000079/** Names the Jellybean API level (16), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070080#define __ANDROID_API_J__ 16
81
Elliott Hughes9823c922019-10-07 20:51:00 +000082/** Names the Jellybean MR1 API level (17), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070083#define __ANDROID_API_J_MR1__ 17
84
Elliott Hughes9823c922019-10-07 20:51:00 +000085/** Names the Jellybean MR2 API level (18), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070086#define __ANDROID_API_J_MR2__ 18
87
Elliott Hughes9823c922019-10-07 20:51:00 +000088/** Names the KitKat API level (19), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070089#define __ANDROID_API_K__ 19
90
Elliott Hughes9823c922019-10-07 20:51:00 +000091/** Names the Lollipop API level (21), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070092#define __ANDROID_API_L__ 21
93
Elliott Hughes9823c922019-10-07 20:51:00 +000094/** Names the Lollipop MR1 API level (22), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070095#define __ANDROID_API_L_MR1__ 22
96
Elliott Hughes9823c922019-10-07 20:51:00 +000097/** Names the Marshmallow API level (23), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -070098#define __ANDROID_API_M__ 23
99
Elliott Hughes9823c922019-10-07 20:51:00 +0000100/** Names the Nougat API level (24), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -0700101#define __ANDROID_API_N__ 24
102
Elliott Hughes9823c922019-10-07 20:51:00 +0000103/** Names the Nougat MR1 API level (25), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -0700104#define __ANDROID_API_N_MR1__ 25
105
Elliott Hughes9823c922019-10-07 20:51:00 +0000106/** Names the Oreo API level (26), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -0700107#define __ANDROID_API_O__ 26
108
Elliott Hughes9823c922019-10-07 20:51:00 +0000109/** Names the Oreo MR1 API level (27), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -0700110#define __ANDROID_API_O_MR1__ 27
111
Elliott Hughes9823c922019-10-07 20:51:00 +0000112/** Names the Pie API level (28), for comparison against `__ANDROID_API__`. */
Elliott Hughesce934e32018-09-06 13:26:08 -0700113#define __ANDROID_API_P__ 28
114
Elliott Hughes9823c922019-10-07 20:51:00 +0000115/**
116 * Names the "Q" API level (29), for comparison against `__ANDROID_API__`.
117 * This release was called Android 10 publicly, not to be (but sure to be)
118 * confused with API level 10.
119 */
Elliott Hughesce934e32018-09-06 13:26:08 -0700120#define __ANDROID_API_Q__ 29
Elliott Hughesc0f46562018-11-09 15:38:52 -0800121
Elliott Hughes9823c922019-10-07 20:51:00 +0000122/** Names the "R" API level (30), for comparison against `__ANDROID_API__`. */
Elliott Hughes42067112019-04-18 14:27:24 -0700123#define __ANDROID_API_R__ 30
124
Elliott Hughesc0f46562018-11-09 15:38:52 -0800125/**
126 * Returns the `targetSdkVersion` of the caller, or `__ANDROID_API_FUTURE__`
127 * if there is no known target SDK version (for code not running in the
128 * context of an app).
129 *
130 * The returned values correspond to the named constants in `<android/api-level.h>`,
131 * and is equivalent to the AndroidManifest.xml `targetSdkVersion`.
132 *
133 * See also android_get_device_api_level().
134 *
135 * Available since API level 24.
136 */
137int android_get_application_target_sdk_version() __INTRODUCED_IN(24);
138
139#if __ANDROID_API__ < __ANDROID_API_Q__
140
Elliott Hughes0f57d562018-11-15 15:07:13 -0800141// android_get_device_api_level is a static inline before API level 29.
Elliott Hughesc0f46562018-11-09 15:38:52 -0800142#define __BIONIC_GET_DEVICE_API_LEVEL_INLINE static __inline
143#include <bits/get_device_api_level_inlines.h>
144#undef __BIONIC_GET_DEVICE_API_LEVEL_INLINE
145
146#else
147
148/**
149 * Returns the API level of the device we're actually running on, or -1 on failure.
150 * The returned values correspond to the named constants in `<android/api-level.h>`,
151 * and is equivalent to the Java `Build.VERSION.SDK_INT` API.
152 *
153 * See also android_get_application_target_sdk_version().
154 */
155int android_get_device_api_level() __INTRODUCED_IN(29);
156
157#endif
158
159__END_DECLS