1 /* 2 * Copyright (C) 2010 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_CONFIGURATION_H 18 #define ANDROID_CONFIGURATION_H 19 20 #include <android/asset_manager.h> 21 22 #ifdef __cplusplus 23 extern "C" { 24 #endif 25 26 struct AConfiguration; 27 typedef struct AConfiguration AConfiguration; 28 29 enum { 30 ACONFIGURATION_ORIENTATION_ANY = 0x0000, 31 ACONFIGURATION_ORIENTATION_PORT = 0x0001, 32 ACONFIGURATION_ORIENTATION_LAND = 0x0002, 33 ACONFIGURATION_ORIENTATION_SQUARE = 0x0003, 34 35 ACONFIGURATION_TOUCHSCREEN_ANY = 0x0000, 36 ACONFIGURATION_TOUCHSCREEN_NOTOUCH = 0x0001, 37 ACONFIGURATION_TOUCHSCREEN_STYLUS = 0x0002, 38 ACONFIGURATION_TOUCHSCREEN_FINGER = 0x0003, 39 40 ACONFIGURATION_DENSITY_DEFAULT = 0, 41 ACONFIGURATION_DENSITY_LOW = 120, 42 ACONFIGURATION_DENSITY_MEDIUM = 160, 43 ACONFIGURATION_DENSITY_HIGH = 240, 44 ACONFIGURATION_DENSITY_NONE = 0xffff, 45 46 ACONFIGURATION_KEYBOARD_ANY = 0x0000, 47 ACONFIGURATION_KEYBOARD_NOKEYS = 0x0001, 48 ACONFIGURATION_KEYBOARD_QWERTY = 0x0002, 49 ACONFIGURATION_KEYBOARD_12KEY = 0x0003, 50 51 ACONFIGURATION_NAVIGATION_ANY = 0x0000, 52 ACONFIGURATION_NAVIGATION_NONAV = 0x0001, 53 ACONFIGURATION_NAVIGATION_DPAD = 0x0002, 54 ACONFIGURATION_NAVIGATION_TRACKBALL = 0x0003, 55 ACONFIGURATION_NAVIGATION_WHEEL = 0x0004, 56 57 ACONFIGURATION_KEYSHIDDEN_ANY = 0x0000, 58 ACONFIGURATION_KEYSHIDDEN_NO = 0x0001, 59 ACONFIGURATION_KEYSHIDDEN_YES = 0x0002, 60 ACONFIGURATION_KEYSHIDDEN_SOFT = 0x0003, 61 62 ACONFIGURATION_NAVHIDDEN_ANY = 0x0000, 63 ACONFIGURATION_NAVHIDDEN_NO = 0x0001, 64 ACONFIGURATION_NAVHIDDEN_YES = 0x0002, 65 66 ACONFIGURATION_SCREENSIZE_ANY = 0x00, 67 ACONFIGURATION_SCREENSIZE_SMALL = 0x01, 68 ACONFIGURATION_SCREENSIZE_NORMAL = 0x02, 69 ACONFIGURATION_SCREENSIZE_LARGE = 0x03, 70 ACONFIGURATION_SCREENSIZE_XLARGE = 0x04, 71 72 ACONFIGURATION_SCREENLONG_ANY = 0x00, 73 ACONFIGURATION_SCREENLONG_NO = 0x1, 74 ACONFIGURATION_SCREENLONG_YES = 0x2, 75 76 ACONFIGURATION_UI_MODE_TYPE_ANY = 0x00, 77 ACONFIGURATION_UI_MODE_TYPE_NORMAL = 0x01, 78 ACONFIGURATION_UI_MODE_TYPE_DESK = 0x02, 79 ACONFIGURATION_UI_MODE_TYPE_CAR = 0x03, 80 81 ACONFIGURATION_UI_MODE_NIGHT_ANY = 0x00, 82 ACONFIGURATION_UI_MODE_NIGHT_NO = 0x1, 83 ACONFIGURATION_UI_MODE_NIGHT_YES = 0x2, 84 85 ACONFIGURATION_MCC = 0x0001, 86 ACONFIGURATION_MNC = 0x0002, 87 ACONFIGURATION_LOCALE = 0x0004, 88 ACONFIGURATION_TOUCHSCREEN = 0x0008, 89 ACONFIGURATION_KEYBOARD = 0x0010, 90 ACONFIGURATION_KEYBOARD_HIDDEN = 0x0020, 91 ACONFIGURATION_NAVIGATION = 0x0040, 92 ACONFIGURATION_ORIENTATION = 0x0080, 93 ACONFIGURATION_DENSITY = 0x0100, 94 ACONFIGURATION_SCREEN_SIZE = 0x0200, 95 ACONFIGURATION_VERSION = 0x0400, 96 ACONFIGURATION_SCREEN_LAYOUT = 0x0800, 97 ACONFIGURATION_UI_MODE = 0x1000, 98 }; 99 100 /** 101 * Create a new AConfiguration, initialized with no values set. 102 */ 103 AConfiguration* AConfiguration_new(); 104 105 /** 106 * Free an AConfiguration that was previously created with 107 * AConfiguration_new(). 108 */ 109 void AConfiguration_delete(AConfiguration* config); 110 111 /** 112 * Create and return a new AConfiguration based on the current configuration in 113 * use in the given AssetManager. 114 */ 115 void AConfiguration_fromAssetManager(AConfiguration* out, AAssetManager* am); 116 117 /** 118 * Copy the contents of 'src' to 'dest'. 119 */ 120 void AConfiguration_copy(AConfiguration* dest, AConfiguration* src); 121 122 /** 123 * Return the current MCC set in the configuration. 0 if not set. 124 */ 125 int32_t AConfiguration_getMcc(AConfiguration* config); 126 127 /** 128 * Set the current MCC in the configuration. 0 to clear. 129 */ 130 void AConfiguration_setMcc(AConfiguration* config, int32_t mcc); 131 132 /** 133 * Return the current MNC set in the configuration. 0 if not set. 134 */ 135 int32_t AConfiguration_getMnc(AConfiguration* config); 136 137 /** 138 * Set the current MNC in the configuration. 0 to clear. 139 */ 140 void AConfiguration_setMnc(AConfiguration* config, int32_t mnc); 141 142 /** 143 * Return the current language code set in the configuration. The output will 144 * be filled with an array of two characters. They are not 0-terminated. If 145 * a language is not set, they will be 0. 146 */ 147 void AConfiguration_getLanguage(AConfiguration* config, char* outLanguage); 148 149 /** 150 * Set the current language code in the configuration, from the first two 151 * characters in the string. 152 */ 153 void AConfiguration_setLanguage(AConfiguration* config, const char* language); 154 155 /** 156 * Return the current country code set in the configuration. The output will 157 * be filled with an array of two characters. They are not 0-terminated. If 158 * a country is not set, they will be 0. 159 */ 160 void AConfiguration_getCountry(AConfiguration* config, char* outCountry); 161 162 /** 163 * Set the current country code in the configuration, from the first two 164 * characters in the string. 165 */ 166 void AConfiguration_setCountry(AConfiguration* config, const char* country); 167 168 /** 169 * Return the current ACONFIGURATION_ORIENTATION_* set in the configuration. 170 */ 171 int32_t AConfiguration_getOrientation(AConfiguration* config); 172 173 /** 174 * Set the current orientation in the configuration. 175 */ 176 void AConfiguration_setOrientation(AConfiguration* config, int32_t orientation); 177 178 /** 179 * Return the current ACONFIGURATION_TOUCHSCREEN_* set in the configuration. 180 */ 181 int32_t AConfiguration_getTouchscreen(AConfiguration* config); 182 183 /** 184 * Set the current touchscreen in the configuration. 185 */ 186 void AConfiguration_setTouchscreen(AConfiguration* config, int32_t touchscreen); 187 188 /** 189 * Return the current ACONFIGURATION_DENSITY_* set in the configuration. 190 */ 191 int32_t AConfiguration_getDensity(AConfiguration* config); 192 193 /** 194 * Set the current density in the configuration. 195 */ 196 void AConfiguration_setDensity(AConfiguration* config, int32_t density); 197 198 /** 199 * Return the current ACONFIGURATION_KEYBOARD_* set in the configuration. 200 */ 201 int32_t AConfiguration_getKeyboard(AConfiguration* config); 202 203 /** 204 * Set the current keyboard in the configuration. 205 */ 206 void AConfiguration_setKeyboard(AConfiguration* config, int32_t keyboard); 207 208 /** 209 * Return the current ACONFIGURATION_NAVIGATION_* set in the configuration. 210 */ 211 int32_t AConfiguration_getNavigation(AConfiguration* config); 212 213 /** 214 * Set the current navigation in the configuration. 215 */ 216 void AConfiguration_setNavigation(AConfiguration* config, int32_t navigation); 217 218 /** 219 * Return the current ACONFIGURATION_KEYSHIDDEN_* set in the configuration. 220 */ 221 int32_t AConfiguration_getKeysHidden(AConfiguration* config); 222 223 /** 224 * Set the current keys hidden in the configuration. 225 */ 226 void AConfiguration_setKeysHidden(AConfiguration* config, int32_t keysHidden); 227 228 /** 229 * Return the current ACONFIGURATION_NAVHIDDEN_* set in the configuration. 230 */ 231 int32_t AConfiguration_getNavHidden(AConfiguration* config); 232 233 /** 234 * Set the current nav hidden in the configuration. 235 */ 236 void AConfiguration_setNavHidden(AConfiguration* config, int32_t navHidden); 237 238 /** 239 * Return the current SDK (API) version set in the configuration. 240 */ 241 int32_t AConfiguration_getSdkVersion(AConfiguration* config); 242 243 /** 244 * Set the current SDK version in the configuration. 245 */ 246 void AConfiguration_setSdkVersion(AConfiguration* config, int32_t sdkVersion); 247 248 /** 249 * Return the current ACONFIGURATION_SCREENSIZE_* set in the configuration. 250 */ 251 int32_t AConfiguration_getScreenSize(AConfiguration* config); 252 253 /** 254 * Set the current screen size in the configuration. 255 */ 256 void AConfiguration_setScreenSize(AConfiguration* config, int32_t screenSize); 257 258 /** 259 * Return the current ACONFIGURATION_SCREENLONG_* set in the configuration. 260 */ 261 int32_t AConfiguration_getScreenLong(AConfiguration* config); 262 263 /** 264 * Set the current screen long in the configuration. 265 */ 266 void AConfiguration_setScreenLong(AConfiguration* config, int32_t screenLong); 267 268 /** 269 * Return the current ACONFIGURATION_UI_MODE_TYPE_* set in the configuration. 270 */ 271 int32_t AConfiguration_getUiModeType(AConfiguration* config); 272 273 /** 274 * Set the current UI mode type in the configuration. 275 */ 276 void AConfiguration_setUiModeType(AConfiguration* config, int32_t uiModeType); 277 278 /** 279 * Return the current ACONFIGURATION_UI_MODE_NIGHT_* set in the configuration. 280 */ 281 int32_t AConfiguration_getUiModeNight(AConfiguration* config); 282 283 /** 284 * Set the current UI mode night in the configuration. 285 */ 286 void AConfiguration_setUiModeNight(AConfiguration* config, int32_t uiModeNight); 287 288 /** 289 * Perform a diff between two configurations. Returns a bit mask of 290 * ACONFIGURATION_* constants, each bit set meaning that configuration element 291 * is different between them. 292 */ 293 int32_t AConfiguration_diff(AConfiguration* config1, AConfiguration* config2); 294 295 /** 296 * Determine whether 'base' is a valid configuration for use within the 297 * environment 'requested'. Returns 0 if there are any values in 'base' 298 * that conflict with 'requested'. Returns 1 if it does not conflict. 299 */ 300 int32_t AConfiguration_match(AConfiguration* base, AConfiguration* requested); 301 302 /** 303 * Determine whether the configuration in 'test' is better than the existing 304 * configuration in 'base'. If 'requested' is non-NULL, this decision is based 305 * on the overall configuration given there. If it is NULL, this decision is 306 * simply based on which configuration is more specific. Returns non-0 if 307 * 'test' is better than 'base'. 308 * 309 * This assumes you have already filtered the configurations with 310 * AConfiguration_match(). 311 */ 312 int32_t AConfiguration_isBetterThan(AConfiguration* base, AConfiguration* test, 313 AConfiguration* requested); 314 315 #ifdef __cplusplus 316 }; 317 #endif 318 319 #endif // ANDROID_CONFIGURATION_H 320