/*
 * Copyright (C) 2022 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.
 */

package com.android.car.internal.property;

import static com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport.PRIVATE_CONSTRUCTOR;
import static com.android.car.internal.common.CommonConstants.EMPTY_BYTE_ARRAY;
import static com.android.car.internal.property.VehiclePropertyIdDebugUtils.isDefined;
import static com.android.car.internal.property.VehiclePropertyIdDebugUtils.toDebugString;

import android.car.VehicleAreaType;
import android.car.VehiclePropertyIds;
import android.car.hardware.CarPropertyValue;
import android.util.ArraySet;

import com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport;

import java.util.Collection;
import java.util.List;
import java.util.Set;
import java.util.StringJoiner;

/**
 * Helper class for CarPropertyService/CarPropertyManager.
 */
public final class CarPropertyHelper {
    /**
     * Error indicating that too many sync operation is ongoing, caller should try again after
     * some time.
     */
    public static final int SYNC_OP_LIMIT_TRY_AGAIN = -1;

    // These are the same values as defined in VHAL interface.
    private static final int VEHICLE_PROPERTY_GROUP_MASK = 0xf0000000;
    private static final int VEHICLE_PROPERTY_GROUP_VENDOR = 0x20000000;
    private static final int VEHICLE_PROPERTY_GROUP_BACKPORTED = 0x30000000;

    // These are the same values as defined in VHAL interface.
    private static final int VEHICLE_PROPERTY_AREA_TYPE_MASK = 0x0f000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_DOOR = 0x06000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_GLOBAL = 0x01000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_MIRROR = 0x04000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_SEAT = 0x05000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_WHEEL = 0x07000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_WINDOW = 0x03000000;
    private static final int VEHICLE_PROPERTY_AREA_TYPE_VENDOR = 0x08000000;

    /**
     * CarPropertyHelper only contains static fields and methods and must never be instantiated.
     */
    @ExcludeFromCodeCoverageGeneratedReport(reason = PRIVATE_CONSTRUCTOR)
    private CarPropertyHelper() {
        throw new UnsupportedOperationException("Must never be called");
    }

    /**
     * Returns whether the property ID is supported by the current Car Service version.
     */
    public static boolean isSupported(int propertyId) {
        return isSystemProperty(propertyId) || isVendorOrBackportedProperty(propertyId);
    }

    /**
     * Gets a user-friendly representation of a list of properties.
     */
    public static String propertyIdsToString(Collection<Integer> propertyIds) {
        var sj = new StringJoiner(", ", "[", "]");
        for (int propertyId : propertyIds) {
            sj.add(toDebugString(propertyId));
        }
        return sj.toString();
    }

    /**
     * Gets a user-friendly representation of a list of properties.
     */
    public static String propertyIdsToString(int[] propertyIds) {
        var sj = new StringJoiner(", ", "[", "]");
        for (int propertyId : propertyIds) {
            sj.add(toDebugString(propertyId));
        }
        return sj.toString();
    }

    /**
     * Returns whether the property ID is defined as a system property.
     */
    public static boolean isSystemProperty(int propertyId) {
        return propertyId != VehiclePropertyIds.INVALID && isDefined(propertyId);
    }

    /**
     * Returns whether the property ID is defined as a vendor property or a backported property.
     */
    public static boolean isVendorOrBackportedProperty(int propertyId) {
        return isVendorProperty(propertyId) || isBackportedProperty(propertyId);
    }

    /**
     * Returns whether the property ID is defined as a vendor property.
     */
    public static boolean isVendorProperty(int propertyId) {
        return (propertyId & VEHICLE_PROPERTY_GROUP_MASK) == VEHICLE_PROPERTY_GROUP_VENDOR;
    }

    /**
     * Returns whether the property ID is defined as a backported property.
     */
    public static boolean isBackportedProperty(int propertyId) {
        return (propertyId & VEHICLE_PROPERTY_GROUP_MASK) == VEHICLE_PROPERTY_GROUP_BACKPORTED;
    }

    /**
     * Gets the default value for a {@link CarPropertyValue} class type.
     */
    public static <T> T getDefaultValue(Class<T> clazz) {
        if (clazz.equals(Boolean.class)) {
            return (T) Boolean.FALSE;
        }
        if (clazz.equals(Integer.class)) {
            return (T) Integer.valueOf(0);
        }
        if (clazz.equals(Long.class)) {
            return (T) Long.valueOf(0);
        }
        if (clazz.equals(Float.class)) {
            return (T) Float.valueOf(0f);
        }
        if (clazz.equals(Integer[].class)) {
            return (T) new Integer[0];
        }
        if (clazz.equals(Long[].class)) {
            return (T) new Long[0];
        }
        if (clazz.equals(Float[].class)) {
            return (T) new Float[0];
        }
        if (clazz.equals(byte[].class)) {
            return (T) EMPTY_BYTE_ARRAY;
        }
        if (clazz.equals(Object[].class)) {
            return (T) new Object[0];
        }
        if (clazz.equals(String.class)) {
            return (T) "";
        }
        throw new IllegalArgumentException("Unexpected class: " + clazz);
    }

    /**
     * Gets the list of [propId, areaId]s included in the subscriptions.
     */
    public static Set<PropIdAreaId> getPropIdAreaIdsFromCarSubscriptions(
            List<CarSubscription> carSubscriptions) {
        Set<PropIdAreaId> propIdAreaIds = new ArraySet<>();
        for (int i = 0; i < carSubscriptions.size(); i++) {
            var option = carSubscriptions.get(i);
            for (int areaId : option.areaIds) {
                PropIdAreaId propIdAreaId = new PropIdAreaId();
                propIdAreaId.propId = option.propertyId;
                propIdAreaId.areaId = areaId;
                propIdAreaIds.add(propIdAreaId);
            }
        }
        return propIdAreaIds;
    }

    /**
     * Creates a new {@link #PropIdAreaId} class.
     */
    public static PropIdAreaId newPropIdAreaId(int propId, int areaId) {
        var propIdAreaId = new PropIdAreaId();
        propIdAreaId.propId = propId;
        propIdAreaId.areaId = areaId;
        return propIdAreaId;
    }

    /**
     * Gets the {@link VehicleAreaType} for the {@link VehiclePropertyIds}.
     */
    public static @VehicleAreaType.VehicleAreaTypeValue int getAreaType(int propertyId) {
        int halAreaType = propertyId & VEHICLE_PROPERTY_AREA_TYPE_MASK;

        switch (halAreaType) {
            case VEHICLE_PROPERTY_AREA_TYPE_DOOR -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_DOOR;
            }
            case VEHICLE_PROPERTY_AREA_TYPE_GLOBAL -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_GLOBAL;
            }
            case VEHICLE_PROPERTY_AREA_TYPE_MIRROR -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_MIRROR;
            }
            case VEHICLE_PROPERTY_AREA_TYPE_SEAT -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_SEAT;
            }
            case VEHICLE_PROPERTY_AREA_TYPE_WHEEL -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_WHEEL;
            }
            case VEHICLE_PROPERTY_AREA_TYPE_WINDOW -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_WINDOW;
            }
            case VEHICLE_PROPERTY_AREA_TYPE_VENDOR -> {
                return VehicleAreaType.VEHICLE_AREA_TYPE_VENDOR;
            }
            default -> {
                throw new IllegalArgumentException(
                        "No defined area type for property ID: " + VehiclePropertyIds.toString(
                                propertyId));
            }
        }
    }
}