blob: 65c96175091c49a75301ac25972c98e2648ac322 [file] [log] [blame]
Adam Lesinski6f6ceb72014-11-14 14:48:12 -08001/*
2 * Copyright (C) 2015 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 AAPT_CONFIG_DESCRIPTION_H
18#define AAPT_CONFIG_DESCRIPTION_H
19
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080020#include <ostream>
21
Adam Lesinskice5e56e2016-10-21 17:56:45 -070022#include "androidfw/ResourceTypes.h"
Adam Lesinskid5083f62017-01-16 15:07:21 -080023#include "androidfw/StringPiece.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070024
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080025namespace aapt {
26
Adam Lesinskibb94f322017-07-12 07:41:55 -070027/*
28 * Subclass of ResTable_config that adds convenient
29 * initialization and comparison methods.
30 */
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080031struct ConfigDescription : public android::ResTable_config {
Adam Lesinskibb94f322017-07-12 07:41:55 -070032 /**
33 * Returns an immutable default config.
34 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -070035 static const ConfigDescription& DefaultConfig();
Adam Lesinski52364f72016-01-11 13:10:24 -080036
Adam Lesinskibb94f322017-07-12 07:41:55 -070037 /*
38 * Parse a string of the form 'fr-sw600dp-land' and fill in the
39 * given ResTable_config with resulting configuration parameters.
40 *
41 * The resulting configuration has the appropriate sdkVersion defined
42 * for backwards compatibility.
43 */
Adam Lesinskid5083f62017-01-16 15:07:21 -080044 static bool Parse(const android::StringPiece& str, ConfigDescription* out = nullptr);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080045
Adam Lesinskibb94f322017-07-12 07:41:55 -070046 /**
47 * If the configuration uses an axis that was added after
48 * the original Android release, make sure the SDK version
49 * is set accordingly.
50 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -070051 static void ApplyVersionForCompatibility(ConfigDescription* config);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080052
Adam Lesinskicacb28f2016-10-19 12:18:14 -070053 ConfigDescription();
54 ConfigDescription(const android::ResTable_config& o); // NOLINT(implicit)
55 ConfigDescription(const ConfigDescription& o);
56 ConfigDescription(ConfigDescription&& o);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080057
Adam Lesinskicacb28f2016-10-19 12:18:14 -070058 ConfigDescription& operator=(const android::ResTable_config& o);
59 ConfigDescription& operator=(const ConfigDescription& o);
60 ConfigDescription& operator=(ConfigDescription&& o);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -080061
Adam Lesinskice5e56e2016-10-21 17:56:45 -070062 ConfigDescription CopyWithoutSdkVersion() const;
Alexandria Cornwall77788eb2016-09-06 15:16:49 -070063
Adam Lesinskibb94f322017-07-12 07:41:55 -070064 /**
65 * A configuration X dominates another configuration Y, if X has at least the
66 * precedence of Y and X is strictly more general than Y: for any type defined
67 * by X, the same type is defined by Y with a value equal to or, in the case
68 * of ranges, more specific than that of X.
69 *
70 * For example, the configuration 'en-w800dp' dominates 'en-rGB-w1024dp'. It
71 * does not dominate 'fr', 'en-w720dp', or 'mcc001-en-w800dp'.
72 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -070073 bool Dominates(const ConfigDescription& o) const;
Alexandria Cornwall77788eb2016-09-06 15:16:49 -070074
Adam Lesinskibb94f322017-07-12 07:41:55 -070075 /**
76 * Returns true if this configuration defines a more important configuration
77 * parameter than o. For example, "en" has higher precedence than "v23",
78 * whereas "en" has the same precedence as "en-v23".
79 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -070080 bool HasHigherPrecedenceThan(const ConfigDescription& o) const;
Alexandria Cornwall77788eb2016-09-06 15:16:49 -070081
Adam Lesinskibb94f322017-07-12 07:41:55 -070082 /**
83 * A configuration conflicts with another configuration if both
84 * configurations define an incompatible configuration parameter. An
85 * incompatible configuration parameter is a non-range, non-density parameter
86 * that is defined in both configurations as a different, non-default value.
87 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -070088 bool ConflictsWith(const ConfigDescription& o) const;
Alexandria Cornwall77788eb2016-09-06 15:16:49 -070089
Adam Lesinskibb94f322017-07-12 07:41:55 -070090 /**
91 * A configuration is compatible with another configuration if both
92 * configurations can match a common concrete device configuration and are
93 * unrelated by domination. For example, land-v11 conflicts with port-v21
94 * but is compatible with v21 (both land-v11 and v21 would match en-land-v23).
95 */
Adam Lesinskice5e56e2016-10-21 17:56:45 -070096 bool IsCompatibleWith(const ConfigDescription& o) const;
Alexandria Cornwall77788eb2016-09-06 15:16:49 -070097
Adam Lesinskice5e56e2016-10-21 17:56:45 -070098 bool MatchWithDensity(const ConfigDescription& o) const;
Alexandria Cornwall77788eb2016-09-06 15:16:49 -070099
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700100 bool operator<(const ConfigDescription& o) const;
101 bool operator<=(const ConfigDescription& o) const;
102 bool operator==(const ConfigDescription& o) const;
103 bool operator!=(const ConfigDescription& o) const;
104 bool operator>=(const ConfigDescription& o) const;
105 bool operator>(const ConfigDescription& o) const;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800106};
107
108inline ConfigDescription::ConfigDescription() {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700109 memset(this, 0, sizeof(*this));
110 size = sizeof(android::ResTable_config);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800111}
112
113inline ConfigDescription::ConfigDescription(const android::ResTable_config& o) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700114 *static_cast<android::ResTable_config*>(this) = o;
115 size = sizeof(android::ResTable_config);
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800116}
117
118inline ConfigDescription::ConfigDescription(const ConfigDescription& o) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700119 *static_cast<android::ResTable_config*>(this) = o;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800120}
121
122inline ConfigDescription::ConfigDescription(ConfigDescription&& o) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700123 *this = o;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800124}
125
Adam Lesinskibb94f322017-07-12 07:41:55 -0700126inline ConfigDescription& ConfigDescription::operator=(
127 const android::ResTable_config& o) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700128 *static_cast<android::ResTable_config*>(this) = o;
129 size = sizeof(android::ResTable_config);
130 return *this;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800131}
132
Adam Lesinskibb94f322017-07-12 07:41:55 -0700133inline ConfigDescription& ConfigDescription::operator=(
134 const ConfigDescription& o) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700135 *static_cast<android::ResTable_config*>(this) = o;
136 return *this;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800137}
138
139inline ConfigDescription& ConfigDescription::operator=(ConfigDescription&& o) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700140 *this = o;
141 return *this;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800142}
143
Adam Lesinskibb94f322017-07-12 07:41:55 -0700144inline bool ConfigDescription::MatchWithDensity(
145 const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700146 return match(o) && (density == 0 || density == o.density);
Alexandria Cornwall77788eb2016-09-06 15:16:49 -0700147}
148
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800149inline bool ConfigDescription::operator<(const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700150 return compare(o) < 0;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800151}
152
153inline bool ConfigDescription::operator<=(const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700154 return compare(o) <= 0;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800155}
156
157inline bool ConfigDescription::operator==(const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700158 return compare(o) == 0;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800159}
160
161inline bool ConfigDescription::operator!=(const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700162 return compare(o) != 0;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800163}
164
165inline bool ConfigDescription::operator>=(const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700166 return compare(o) >= 0;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800167}
168
169inline bool ConfigDescription::operator>(const ConfigDescription& o) const {
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700170 return compare(o) > 0;
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800171}
172
Adam Lesinskibb94f322017-07-12 07:41:55 -0700173inline ::std::ostream& operator<<(::std::ostream& out,
174 const ConfigDescription& o) {
175 return out << o.toString().string();
176}
177
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700178} // namespace aapt
Adam Lesinski6f6ceb72014-11-14 14:48:12 -0800179
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700180#endif // AAPT_CONFIG_DESCRIPTION_H