1/*
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
20#include <ostream>
21
22#include "androidfw/ResourceTypes.h"
23#include "androidfw/StringPiece.h"
24
25namespace aapt {
26
27/*
28 * Subclass of ResTable_config that adds convenient
29 * initialization and comparison methods.
30 */
31struct ConfigDescription : public android::ResTable_config {
32  /**
33   * Returns an immutable default config.
34   */
35  static const ConfigDescription& DefaultConfig();
36
37  /*
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   */
44  static bool Parse(const android::StringPiece& str, ConfigDescription* out = nullptr);
45
46  /**
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   */
51  static void ApplyVersionForCompatibility(ConfigDescription* config);
52
53  ConfigDescription();
54  ConfigDescription(const android::ResTable_config& o);  // NOLINT(implicit)
55  ConfigDescription(const ConfigDescription& o);
56  ConfigDescription(ConfigDescription&& o);
57
58  ConfigDescription& operator=(const android::ResTable_config& o);
59  ConfigDescription& operator=(const ConfigDescription& o);
60  ConfigDescription& operator=(ConfigDescription&& o);
61
62  ConfigDescription CopyWithoutSdkVersion() const;
63
64  /**
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   */
73  bool Dominates(const ConfigDescription& o) const;
74
75  /**
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   */
80  bool HasHigherPrecedenceThan(const ConfigDescription& o) const;
81
82  /**
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   */
88  bool ConflictsWith(const ConfigDescription& o) const;
89
90  /**
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   */
96  bool IsCompatibleWith(const ConfigDescription& o) const;
97
98  bool MatchWithDensity(const ConfigDescription& o) const;
99
100  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;
106};
107
108inline ConfigDescription::ConfigDescription() {
109  memset(this, 0, sizeof(*this));
110  size = sizeof(android::ResTable_config);
111}
112
113inline ConfigDescription::ConfigDescription(const android::ResTable_config& o) {
114  *static_cast<android::ResTable_config*>(this) = o;
115  size = sizeof(android::ResTable_config);
116}
117
118inline ConfigDescription::ConfigDescription(const ConfigDescription& o) {
119  *static_cast<android::ResTable_config*>(this) = o;
120}
121
122inline ConfigDescription::ConfigDescription(ConfigDescription&& o) {
123  *this = o;
124}
125
126inline ConfigDescription& ConfigDescription::operator=(
127    const android::ResTable_config& o) {
128  *static_cast<android::ResTable_config*>(this) = o;
129  size = sizeof(android::ResTable_config);
130  return *this;
131}
132
133inline ConfigDescription& ConfigDescription::operator=(
134    const ConfigDescription& o) {
135  *static_cast<android::ResTable_config*>(this) = o;
136  return *this;
137}
138
139inline ConfigDescription& ConfigDescription::operator=(ConfigDescription&& o) {
140  *this = o;
141  return *this;
142}
143
144inline bool ConfigDescription::MatchWithDensity(
145    const ConfigDescription& o) const {
146  return match(o) && (density == 0 || density == o.density);
147}
148
149inline bool ConfigDescription::operator<(const ConfigDescription& o) const {
150  return compare(o) < 0;
151}
152
153inline bool ConfigDescription::operator<=(const ConfigDescription& o) const {
154  return compare(o) <= 0;
155}
156
157inline bool ConfigDescription::operator==(const ConfigDescription& o) const {
158  return compare(o) == 0;
159}
160
161inline bool ConfigDescription::operator!=(const ConfigDescription& o) const {
162  return compare(o) != 0;
163}
164
165inline bool ConfigDescription::operator>=(const ConfigDescription& o) const {
166  return compare(o) >= 0;
167}
168
169inline bool ConfigDescription::operator>(const ConfigDescription& o) const {
170  return compare(o) > 0;
171}
172
173inline ::std::ostream& operator<<(::std::ostream& out,
174                                  const ConfigDescription& o) {
175  return out << o.toString().string();
176}
177
178}  // namespace aapt
179
180#endif  // AAPT_CONFIG_DESCRIPTION_H
181