windowmanager/wmserver/include/window_pair.h

/*
 * Copyright (c) 2022 Huawei Device Co., Ltd.
 * 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 OHOS_ROSEN_WINDOW_PAIR_H
#define OHOS_ROSEN_WINDOW_PAIR_H

#include <refbase.h>
#include "window_inner_manager.h"
#include "window_node.h"
#include "wm_common_inner.h"
#include "wm_common.h"

namespace OHOS {
namespace Rosen {
/**
 * Enumerates the status of window pair.
 */
enum class WindowPairStatus : uint32_t {
    STATUS_EMPTY,
    STATUS_SINGLE_PRIMARY,
    STATUS_SINGLE_SECONDARY,
    STATUS_PAIRING,
    STATUS_PAIRED_DONE
};

/**
 * Enumerates the message of split event.
 */
enum class SplitBroadcastMsg : uint32_t {
    MSG_NONE,
    MSG_START_PRIMARY,
    MSG_START_SECONDARY,
    MSG_START_DIVIDER
};

class WindowPair : public RefBase {
public:
    /**
     * Constructor used to create an empty WindowPair instance.
     *
     * @param displayId the disply of window pair
     * @param appNode the window root of app window
     */
    WindowPair(const DisplayId& displayId, sptr<WindowNode>& appNode);

    /**
     * Deconstructor used to deconstruct.
     *
     */
    ~WindowPair();

    /**
     * Clear window pair.
     *
     */
    void Clear();

    /**
     * Set split ratio.
     *
     * @param ratio split ratio
     */
    void SetSplitRatio(float ratio);

    /**
     * Get split ratio.
     *
     * @return split ratio
     */
    float GetSplitRatio() const;

    /**
     * Get whether the window pair is paired..
     *
     * @return the pair state of window pair
     */
    bool IsPaired() const;

    /**
     * Handle changes in the state of the window pair
     *
     * @param node trigger window node
     */
    void UpdateIfSplitRelated(sptr<WindowNode>& node);

    /**
     * Handle remove window from pair.
     *
     * @param node target node
     */
    void HandleRemoveWindow(sptr<WindowNode>& node);

    /**
     * Find window node from window pair.
     *
     * @param node target window node
     * @return window node
     */
    sptr<WindowNode> Find(sptr<WindowNode>& node);

    /**
     * Get primary window node.
     *
     * @return primary window node
     */
    sptr<WindowNode> GetPrimaryWindow() const;

    /**
     * Get secondary window node.
     *
     * @return secondary window node
     */
    sptr<WindowNode> GetSecondaryWindow() const;

    /**
     * Get divider window node.
     *
     * @return divider window node
     */
    sptr<WindowNode> GetDividerWindow() const;

    /**
     * Get pair status.
     *
     * @return the pair status of window pair
     */
    WindowPairStatus GetPairStatus() const;

    /**
     * Get all window node form pair in Z order.
     *
     * @return the list window form pair
     */
    std::vector<sptr<WindowNode>> GetOrderedPair(sptr<WindowNode>& node);

    /**
     * Get all window node form pair.
     *
     * @return the list window form pair
     */
    std::vector<sptr<WindowNode>> GetPairedWindows();

private:
    /**
     * Gets whether the window is related to split window.
     *
     * @param node target node
     * @return Whether target node is related to the split window
     */
    bool IsSplitRelated(sptr<WindowNode>& node) const;

    /**
     * Replace paired window.
     *
     * @param node current node
     */
    void Insert(sptr<WindowNode>& node);

    /**
     * Update paired window node
     *
     */
    void HandlePairedNodesChange();

    /**
     * Update pair status
     *
     */
    void UpdateWindowPairStatus();

    /**
     * Switch the position of two paired window.
     *
     */
    void SwitchPosition();

    /**
     * Dump the info of pair.
     *
     */
    void DumpPairInfo();

    /**
     * Send inner window message.
     *
     * @param cmd the message of inner window manager
     * @param displayId the id of target display
     */
    void SendInnerMessage(InnerWMCmd cmd, DisplayId displayId);

    /**
     * Find pairable window frome window trees.
     *
     * @param node the node waiting to be paired
     * @return window node
     */
    sptr<WindowNode> FindPairableWindow(sptr<WindowNode>& node);

    /**
     * Get pairable node from trees or send split broadcast.
     *
     * @param node the node waiting to be paired
     * @return pairable node
     */
    sptr<WindowNode> GetPairableWindow(sptr<WindowNode>& node);

    /**
     * Send brodcast message of split event.
     *
     * @param node trigger node
     */
    void SendBroadcastMsg(sptr<WindowNode>& node);

private:
    float ratio_ = DEFAULT_SPLIT_RATIO;
    DisplayId displayId_;
    sptr<WindowNode> appWindowNode_;
    sptr<WindowNode> primary_;
    sptr<WindowNode> secondary_;
    sptr<WindowNode> divider_;
    WindowPairStatus status_ = {WindowPairStatus::STATUS_EMPTY};
};
} // namespace Rosen
} // namespace OHOS
#endif // OHOS_ROSEN_WINDOW_PAIR_H