xref: /aosp_15_r20/system/libvintf/MatrixInstance.cpp (revision 70a7ec852fcefd15a4fb57f8f183a8b1c3aacb08)
1*70a7ec85SAndroid Build Coastguard Worker /*
2*70a7ec85SAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*70a7ec85SAndroid Build Coastguard Worker  *
4*70a7ec85SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*70a7ec85SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*70a7ec85SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*70a7ec85SAndroid Build Coastguard Worker  *
8*70a7ec85SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*70a7ec85SAndroid Build Coastguard Worker  *
10*70a7ec85SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*70a7ec85SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*70a7ec85SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*70a7ec85SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*70a7ec85SAndroid Build Coastguard Worker  * limitations under the License.
15*70a7ec85SAndroid Build Coastguard Worker  */
16*70a7ec85SAndroid Build Coastguard Worker 
17*70a7ec85SAndroid Build Coastguard Worker #include "MatrixInstance.h"
18*70a7ec85SAndroid Build Coastguard Worker 
19*70a7ec85SAndroid Build Coastguard Worker #include <utility>
20*70a7ec85SAndroid Build Coastguard Worker 
21*70a7ec85SAndroid Build Coastguard Worker #include "Regex.h"
22*70a7ec85SAndroid Build Coastguard Worker #include "parse_string.h"
23*70a7ec85SAndroid Build Coastguard Worker 
24*70a7ec85SAndroid Build Coastguard Worker namespace android {
25*70a7ec85SAndroid Build Coastguard Worker namespace vintf {
26*70a7ec85SAndroid Build Coastguard Worker 
27*70a7ec85SAndroid Build Coastguard Worker MatrixInstance::MatrixInstance() = default;
28*70a7ec85SAndroid Build Coastguard Worker 
29*70a7ec85SAndroid Build Coastguard Worker MatrixInstance::MatrixInstance(const MatrixInstance&) = default;
30*70a7ec85SAndroid Build Coastguard Worker 
31*70a7ec85SAndroid Build Coastguard Worker MatrixInstance::MatrixInstance(MatrixInstance&&) noexcept = default;
32*70a7ec85SAndroid Build Coastguard Worker 
33*70a7ec85SAndroid Build Coastguard Worker MatrixInstance& MatrixInstance::operator=(const MatrixInstance&) = default;
34*70a7ec85SAndroid Build Coastguard Worker 
35*70a7ec85SAndroid Build Coastguard Worker MatrixInstance& MatrixInstance::operator=(MatrixInstance&&) noexcept = default;
36*70a7ec85SAndroid Build Coastguard Worker 
MatrixInstance(HalFormat format,ExclusiveTo exclusiveTo,FqInstance && fqInstance,VersionRange && range,bool optional,bool isRegex)37*70a7ec85SAndroid Build Coastguard Worker MatrixInstance::MatrixInstance(HalFormat format, ExclusiveTo exclusiveTo, FqInstance&& fqInstance,
38*70a7ec85SAndroid Build Coastguard Worker                                VersionRange&& range, bool optional, bool isRegex)
39*70a7ec85SAndroid Build Coastguard Worker     : mFormat(format),
40*70a7ec85SAndroid Build Coastguard Worker       mExclusiveTo(exclusiveTo),
41*70a7ec85SAndroid Build Coastguard Worker       mFqInstance(std::move(fqInstance)),
42*70a7ec85SAndroid Build Coastguard Worker       mRange(std::move(range)),
43*70a7ec85SAndroid Build Coastguard Worker       mOptional(optional),
44*70a7ec85SAndroid Build Coastguard Worker       mIsRegex(isRegex) {}
45*70a7ec85SAndroid Build Coastguard Worker 
MatrixInstance(HalFormat format,ExclusiveTo exclusiveTo,const FqInstance fqInstance,const VersionRange & range,bool optional,bool isRegex)46*70a7ec85SAndroid Build Coastguard Worker MatrixInstance::MatrixInstance(HalFormat format, ExclusiveTo exclusiveTo,
47*70a7ec85SAndroid Build Coastguard Worker                                const FqInstance fqInstance, const VersionRange& range,
48*70a7ec85SAndroid Build Coastguard Worker                                bool optional, bool isRegex)
49*70a7ec85SAndroid Build Coastguard Worker     : mFormat(format),
50*70a7ec85SAndroid Build Coastguard Worker       mExclusiveTo(exclusiveTo),
51*70a7ec85SAndroid Build Coastguard Worker       mFqInstance(fqInstance),
52*70a7ec85SAndroid Build Coastguard Worker       mRange(range),
53*70a7ec85SAndroid Build Coastguard Worker       mOptional(optional),
54*70a7ec85SAndroid Build Coastguard Worker       mIsRegex(isRegex) {}
55*70a7ec85SAndroid Build Coastguard Worker 
package() const56*70a7ec85SAndroid Build Coastguard Worker const std::string& MatrixInstance::package() const {
57*70a7ec85SAndroid Build Coastguard Worker     return mFqInstance.getPackage();
58*70a7ec85SAndroid Build Coastguard Worker }
59*70a7ec85SAndroid Build Coastguard Worker 
versionRange() const60*70a7ec85SAndroid Build Coastguard Worker const VersionRange& MatrixInstance::versionRange() const {
61*70a7ec85SAndroid Build Coastguard Worker     return mRange;
62*70a7ec85SAndroid Build Coastguard Worker }
63*70a7ec85SAndroid Build Coastguard Worker 
interface() const64*70a7ec85SAndroid Build Coastguard Worker std::string MatrixInstance::interface() const {
65*70a7ec85SAndroid Build Coastguard Worker     return mFqInstance.getInterface();
66*70a7ec85SAndroid Build Coastguard Worker }
67*70a7ec85SAndroid Build Coastguard Worker 
format() const68*70a7ec85SAndroid Build Coastguard Worker HalFormat MatrixInstance::format() const {
69*70a7ec85SAndroid Build Coastguard Worker     return mFormat;
70*70a7ec85SAndroid Build Coastguard Worker }
71*70a7ec85SAndroid Build Coastguard Worker 
exclusiveTo() const72*70a7ec85SAndroid Build Coastguard Worker ExclusiveTo MatrixInstance::exclusiveTo() const {
73*70a7ec85SAndroid Build Coastguard Worker     return mExclusiveTo;
74*70a7ec85SAndroid Build Coastguard Worker }
75*70a7ec85SAndroid Build Coastguard Worker 
optional() const76*70a7ec85SAndroid Build Coastguard Worker bool MatrixInstance::optional() const {
77*70a7ec85SAndroid Build Coastguard Worker     return mOptional;
78*70a7ec85SAndroid Build Coastguard Worker }
79*70a7ec85SAndroid Build Coastguard Worker 
isSatisfiedBy(const FqInstance & provided) const80*70a7ec85SAndroid Build Coastguard Worker bool MatrixInstance::isSatisfiedBy(const FqInstance& provided) const {
81*70a7ec85SAndroid Build Coastguard Worker     return package() == provided.getPackage() &&
82*70a7ec85SAndroid Build Coastguard Worker            versionRange().supportedBy(provided.getVersion()) &&
83*70a7ec85SAndroid Build Coastguard Worker            interface() == provided.getInterface() && matchInstance(provided.getInstance());
84*70a7ec85SAndroid Build Coastguard Worker }
85*70a7ec85SAndroid Build Coastguard Worker 
matchInstance(const std::string & e) const86*70a7ec85SAndroid Build Coastguard Worker bool MatrixInstance::matchInstance(const std::string& e) const {
87*70a7ec85SAndroid Build Coastguard Worker     if (!isRegex()) {
88*70a7ec85SAndroid Build Coastguard Worker         return exactInstance() == e;
89*70a7ec85SAndroid Build Coastguard Worker     }
90*70a7ec85SAndroid Build Coastguard Worker     details::Regex regex;
91*70a7ec85SAndroid Build Coastguard Worker     if (!regex.compile(regexPattern())) {
92*70a7ec85SAndroid Build Coastguard Worker         return false;
93*70a7ec85SAndroid Build Coastguard Worker     }
94*70a7ec85SAndroid Build Coastguard Worker     return regex.matches(e);
95*70a7ec85SAndroid Build Coastguard Worker }
96*70a7ec85SAndroid Build Coastguard Worker 
regexPattern() const97*70a7ec85SAndroid Build Coastguard Worker const std::string& MatrixInstance::regexPattern() const {
98*70a7ec85SAndroid Build Coastguard Worker     static const std::string kEmptyString;
99*70a7ec85SAndroid Build Coastguard Worker     return isRegex() ? mFqInstance.getInstance() : kEmptyString;
100*70a7ec85SAndroid Build Coastguard Worker }
101*70a7ec85SAndroid Build Coastguard Worker 
exactInstance() const102*70a7ec85SAndroid Build Coastguard Worker const std::string& MatrixInstance::exactInstance() const {
103*70a7ec85SAndroid Build Coastguard Worker     static const std::string kEmptyString;
104*70a7ec85SAndroid Build Coastguard Worker     return isRegex() ? kEmptyString : mFqInstance.getInstance();
105*70a7ec85SAndroid Build Coastguard Worker }
106*70a7ec85SAndroid Build Coastguard Worker 
isRegex() const107*70a7ec85SAndroid Build Coastguard Worker bool MatrixInstance::isRegex() const {
108*70a7ec85SAndroid Build Coastguard Worker     return mIsRegex;
109*70a7ec85SAndroid Build Coastguard Worker }
110*70a7ec85SAndroid Build Coastguard Worker 
interfaceDescription(Version replaceVersion) const111*70a7ec85SAndroid Build Coastguard Worker std::string MatrixInstance::interfaceDescription(Version replaceVersion) const {
112*70a7ec85SAndroid Build Coastguard Worker     switch (format()) {
113*70a7ec85SAndroid Build Coastguard Worker         case HalFormat::HIDL:
114*70a7ec85SAndroid Build Coastguard Worker             [[fallthrough]];
115*70a7ec85SAndroid Build Coastguard Worker         case HalFormat::NATIVE: {
116*70a7ec85SAndroid Build Coastguard Worker             return toFQNameString(package(), replaceVersion, interface());
117*70a7ec85SAndroid Build Coastguard Worker         } break;
118*70a7ec85SAndroid Build Coastguard Worker         case HalFormat::AIDL: {
119*70a7ec85SAndroid Build Coastguard Worker             return toAidlFqnameString(package(), interface()) + " (@" +
120*70a7ec85SAndroid Build Coastguard Worker                    aidlVersionToString(replaceVersion) + ")";
121*70a7ec85SAndroid Build Coastguard Worker         } break;
122*70a7ec85SAndroid Build Coastguard Worker     }
123*70a7ec85SAndroid Build Coastguard Worker }
124*70a7ec85SAndroid Build Coastguard Worker 
description(Version replaceVersion) const125*70a7ec85SAndroid Build Coastguard Worker std::string MatrixInstance::description(Version replaceVersion) const {
126*70a7ec85SAndroid Build Coastguard Worker     std::string instanceDescription = isRegex() ? regexPattern() : exactInstance();
127*70a7ec85SAndroid Build Coastguard Worker     switch (format()) {
128*70a7ec85SAndroid Build Coastguard Worker         case HalFormat::HIDL:
129*70a7ec85SAndroid Build Coastguard Worker             [[fallthrough]];
130*70a7ec85SAndroid Build Coastguard Worker         case HalFormat::NATIVE: {
131*70a7ec85SAndroid Build Coastguard Worker             return toFQNameString(package(), replaceVersion, interface(), instanceDescription);
132*70a7ec85SAndroid Build Coastguard Worker         } break;
133*70a7ec85SAndroid Build Coastguard Worker         case HalFormat::AIDL: {
134*70a7ec85SAndroid Build Coastguard Worker             return toAidlFqnameString(package(), interface(), instanceDescription) + " (@" +
135*70a7ec85SAndroid Build Coastguard Worker                    aidlVersionToString(replaceVersion) + ")";
136*70a7ec85SAndroid Build Coastguard Worker         } break;
137*70a7ec85SAndroid Build Coastguard Worker     }
138*70a7ec85SAndroid Build Coastguard Worker }
139*70a7ec85SAndroid Build Coastguard Worker 
140*70a7ec85SAndroid Build Coastguard Worker }  // namespace vintf
141*70a7ec85SAndroid Build Coastguard Worker }  // namespace android
142