/*
 * 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.server.wm;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.annotation.UserIdInt;
import android.util.Pair;


import java.util.List;

/**
 * Interface implemented by {@code CarLaunchParamsModifier} and used by
 * {@code CarLaunchParamsModifierUpdatable}.
 *
 * Because {@code CarLaunchParamsModifierUpdatable} calls {@code CarLaunchParamsModifierInterface}
 * with {@code mLock} acquired, {@code CarLaunchParamsModifierInterface} shouldn't call
 * {@code CarLaunchParamsModifierUpdatable} again during its execution.
 * @hide
 */
@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
public interface CarLaunchParamsModifierInterface {
    /**
     * Returns {@link TaskDisplayAreaWrapper} of the given {@code featureId} in the given
     * {@code displayId}.
     */
    @Nullable TaskDisplayAreaWrapper findTaskDisplayArea(int displayId, int featureId);

    /**
     * Returns the default {@link TaskDisplayAreaWrapper} of the given {@code displayId}.
     */
    @Nullable TaskDisplayAreaWrapper getDefaultTaskDisplayAreaOnDisplay(int displayId);

    /**
     * Returns the list of fallback {@link TaskDisplayAreaWrapper} from the source of the request.
     */
    @NonNull List<TaskDisplayAreaWrapper> getFallbackDisplayAreasForActivity(
            @NonNull ActivityRecordWrapper activityRecord, @Nullable RequestWrapper request);

    /**
     * @return a pair of the current userId and the target userId.
     * The target userId is the user to switch during switching the driver,
     * or {@link android.os.UserHandle.USER_NULL}.
     */
    @NonNull Pair<Integer, Integer> getCurrentAndTargetUserIds();

    /**
     * Returns the main user (i.e., not a profile) that is assigned to the display, or the
     * {@link android.app.ActivityManager#getCurrentUser() current foreground user} if no user is
     * associated with the display.
     * See {@link com.android.server.pm.UserManagerInternal#getUserAssignedToDisplay(int)} for
     * the detail.
     */
    @UserIdInt int getUserAssignedToDisplay(int displayId);

    /**
     * Returns the main display id assigned to the user, or {@code Display.INVALID_DISPLAY} if the
     * user is not assigned to any main display.
     * See {@link com.android.server.pm.UserManagerInternal#getMainDisplayAssignedToUser(int)} for
     * the detail.
     */
    int getMainDisplayAssignedToUser(@UserIdInt int userId);
}