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

import android.annotation.NonNull;
import android.graphics.Region;

import com.android.wm.shell.desktopmode.data.DesktopRepository;
import com.android.wm.shell.shared.annotations.ExternalThread;
import com.android.wm.shell.shared.desktopmode.DesktopFirstListener;
import com.android.wm.shell.shared.desktopmode.DesktopModeTransitionSource;

import java.util.concurrent.Executor;
import java.util.function.Consumer;

/**
 * Interface to interact with desktop mode feature in shell.
 */
@ExternalThread
public interface DesktopMode {

    /**
     * Adds a listener to find out about changes in the visibility of freeform tasks.
     *
     * @param listener the listener to add.
     * @param callbackExecutor the executor to call the listener on.
     */
    void addVisibleTasksListener(DesktopRepository.VisibleTasksListener listener,
            Executor callbackExecutor);

    /**
     * Adds a listener to find out about desk changes.
     *
     * @param listener the listener to add.
     * @param callbackExecutor the executor to call the listener on.
     */
    void addDeskChangeListener(DesktopRepository.DeskChangeListener listener,
            Executor callbackExecutor);

    /**
     * Adds a consumer to listen for Desktop task corner changes. This is used for gesture
     * exclusion. The SparseArray contains a list of four corner resize handles mapped to each
     * desktop task's taskId. The resize handle Rects are stored in the following order:
     * left-top, left-bottom, right-top, right-bottom.
     */
    default void addDesktopGestureExclusionRegionListener(Consumer<Region> listener,
            Executor callbackExecutor) { }


    /** Called when requested to go to desktop mode from the current focused app. */
    void moveFocusedTaskToDesktop(int displayId, DesktopModeTransitionSource transitionSource);

    /** Called when requested to go to fullscreen from the current focused desktop app. */
    void moveFocusedTaskToFullscreen(int displayId, DesktopModeTransitionSource transitionSource);

    /** Called when requested to go to split screen from the current focused desktop app. */
    void moveFocusedTaskToStageSplit(int displayId, boolean leftOrTop);

    /** Called when requested to toggle the fullscreen state of the focused app. */
    void toggleFocusedTaskFullscreenState(
            int displayId, DesktopModeTransitionSource transitionSource);

    /**
     * Register a listener that will receive callbacks about desktop-first state. Once it's
     * registered, the listener immediately receives the current state.
     */
    void registerDesktopFirstListener(@NonNull DesktopFirstListener listener);

    /**
     * Unregister a registered desktop-first listener
     */
    void unregisterDesktopFirstListener(@NonNull DesktopFirstListener listener);

    /** Check is a specific displayId is in DesktopMode. */
    boolean isDisplayInDesktopMode(int displayId);
}