xref: /aosp_15_r20/system/libvintf/include/vintf/MatrixInstance.h (revision 70a7ec852fcefd15a4fb57f8f183a8b1c3aacb08)

/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ANDROID_VINTF_MATRIX_INSTANCE_H
#define ANDROID_VINTF_MATRIX_INSTANCE_H

#include <string>

#include <vintf/ExclusiveTo.h>
#include <vintf/FqInstance.h>
#include <vintf/HalFormat.h>
#include <vintf/VersionRange.h>

namespace android {
namespace vintf {

class MatrixInstance {
   public:
    MatrixInstance();
    MatrixInstance(const MatrixInstance&);
    MatrixInstance(MatrixInstance&&) noexcept;
    MatrixInstance& operator=(const MatrixInstance&);
    MatrixInstance& operator=(MatrixInstance&&) noexcept;

    using VersionType = VersionRange;
    // fqInstance.version is ignored. Version range is provided separately.
    MatrixInstance(HalFormat format, ExclusiveTo exclusiveTo, FqInstance&& fqInstance,
                   VersionRange&& range, bool optional, bool isRegex);
    MatrixInstance(HalFormat format, ExclusiveTo exclusiveTo, const FqInstance fqInstance,
                   const VersionRange& range, bool optional, bool isRegex);
    const std::string& package() const;
    const VersionRange& versionRange() const;
    std::string interface() const;
    bool optional() const;
    HalFormat format() const;
    ExclusiveTo exclusiveTo() const;

    bool isSatisfiedBy(const FqInstance& provided) const;

    // If isRegex, return true if instance matches the pattern.
    // If !isRegex, return true if e == instance().
    // Follows rules of "Extended Regular Expression" (ERE).
    bool matchInstance(const std::string& e) const;

    // If isRegex, return the regex pattern. Else empty string.
    const std::string& regexPattern() const;

    // If !isRegex, return the exact instance name. Else empty string.
    const std::string& exactInstance() const;

    bool isRegex() const;

    // Return a human-readable description of the interface.
    // Version is replaced by replaceVersion.
    // e.g. for HIDL, [email protected]::IFoo,
    //      for AIDL, android.hardware.foo.IFoo (@1)
    std::string interfaceDescription(Version replaceVersion) const;

    // Return a human-readable description of the instance.
    // Version is replaced by replaceVersion.
    // e.g. for HIDL, [email protected]::IFoo/default,
    //      for AIDL, android.hardware.foo.IFoo/default (@1)
    std::string description(Version replaceVersion) const;

   private:
    HalFormat mFormat = HalFormat::HIDL;
    ExclusiveTo mExclusiveTo = ExclusiveTo::EMPTY;
    FqInstance mFqInstance;
    VersionRange mRange;
    bool mOptional = false;
    bool mIsRegex = false;
};

}  // namespace vintf
}  // namespace android

#endif  // ANDROID_VINTF_MATRIX_INSTANCE_H