xref: /foundation/multimodalinput/input/service/subscriber/include/key_gesture_manager.h

/*
 * Copyright (c) 2024 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 KEY_GESTURE_MANAGER_H
#define KEY_GESTURE_MANAGER_H

#include <functional>
#include <set>
#include <sstream>

#include <nocopyable.h>

#include "key_event.h"
#include "key_option.h"

namespace OHOS {
namespace MMI {

class KeyGestureManager final {
private:
    class Handler final {
    public:
        Handler(int32_t id, int32_t pid, int32_t longPressTime,
                std::function<void(std::shared_ptr<KeyEvent>)> callback)
            : id_(id), pid_(pid), longPressTime_(longPressTime), callback_(callback) {}
        ~Handler();

        int32_t GetId() const
        {
            return id_;
        }

        int32_t GetPid() const
        {
            return pid_;
        }

        int32_t GetLongPressTime() const
        {
            return longPressTime_;
        }

        void SetLongPressTime(int32_t longPressTime)
        {
            longPressTime_ = longPressTime;
        }

        void ResetTimer();
        void Trigger(std::shared_ptr<KeyEvent> keyEvent);
        void Run(std::shared_ptr<KeyEvent> keyEvent) const;
        void RunPending();

    private:
        int32_t id_ { -1 };
        int32_t pid_ { -1 };
        int32_t longPressTime_ { -1 };
        int32_t timerId_ { -1 };
        std::shared_ptr<KeyEvent> keyEvent_;
        std::function<void(std::shared_ptr<KeyEvent>)> callback_;
    };

    class KeyGesture {
    public:
        KeyGesture() = default;
        virtual ~KeyGesture() = default;

        virtual bool IsWorking();
        virtual bool ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const = 0;
        virtual bool Intercept(std::shared_ptr<KeyEvent> KeyEvent) = 0;
        virtual void Dump(std::ostringstream &output) const = 0;
        virtual int32_t AddHandler(int32_t pid, int32_t longPressTime,
            std::function<void(std::shared_ptr<KeyEvent>)> callback);
        bool RemoveHandler(int32_t id);
        void Reset();
        bool IsActive() const;
        void MarkActive(bool active);

    protected:
        void ResetTimers();
        std::set<int32_t> GetForegroundPids() const;
        bool HaveForegroundHandler(const std::set<int32_t> &foregroundApps) const;
        void TriggerHandlers(std::shared_ptr<KeyEvent> keyEvent);
        void RunHandler(int32_t handlerId, std::shared_ptr<KeyEvent> keyEvent);
        void NotifyHandlers(std::shared_ptr<KeyEvent> keyEvent);
        void ShowHandlers(const std::string &prefix, const std::set<int32_t> &foregroundApps) const;

        bool active_ { false };
        std::set<int32_t> keys_;
        std::vector<Handler> handlers_;
    };

private:
    class LongPressSingleKey : public KeyGesture {
    public:
        LongPressSingleKey(int32_t keyCode) : keyCode_(keyCode) {}
        ~LongPressSingleKey() = default;

        bool ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const override;
        bool Intercept(std::shared_ptr<KeyEvent> KeyEvent) override;
        void Dump(std::ostringstream &output) const override;

    private:
        void RunPendingHandlers();

        int32_t keyCode_ { -1 };
        int64_t firstDownTime_ {};
    };

    class LongPressCombinationKey : public KeyGesture {
    public:
        LongPressCombinationKey(const std::set<int32_t> &keys) : keys_(keys) {}
        ~LongPressCombinationKey() = default;

        bool ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const override;
        bool Intercept(std::shared_ptr<KeyEvent> keyEvent) override;
        void Dump(std::ostringstream &output) const override;

    protected:
        virtual void OnTriggerAll(std::shared_ptr<KeyEvent> keyEvent) {}

    private:
        bool RecognizeGesture(std::shared_ptr<KeyEvent> keyEvent);
        void TriggerAll(std::shared_ptr<KeyEvent> keyEvent);

        int64_t firstDownTime_ {};
        std::set<int32_t> keys_;
    };

    class PullUpAccessibility final : public LongPressCombinationKey {
    public:
        PullUpAccessibility();
        ~PullUpAccessibility() = default;

        bool IsWorking() override;
        int32_t AddHandler(int32_t pid, int32_t longPressTime,
            std::function<void(std::shared_ptr<KeyEvent>)> callback) override;
        void OnTriggerAll(std::shared_ptr<KeyEvent> keyEvent) override;
    };

public:
    KeyGestureManager();
    ~KeyGestureManager() = default;
    DISALLOW_COPY_AND_MOVE(KeyGestureManager);

    bool ShouldIntercept(std::shared_ptr<KeyOption> keyOption) const;
    int32_t AddKeyGesture(int32_t pid, std::shared_ptr<KeyOption> keyOption,
        std::function<void(std::shared_ptr<KeyEvent>)> callback);
    void RemoveKeyGesture(int32_t id);
    bool Intercept(std::shared_ptr<KeyEvent> KeyEvent);
    void ResetAll();
    void Dump() const;

private:
    std::vector<std::unique_ptr<KeyGesture>> keyGestures_;
};

inline bool KeyGestureManager::KeyGesture::IsActive() const
{
    return active_;
}

inline void KeyGestureManager::KeyGesture::MarkActive(bool active)
{
    active_ = active;
}
} // namespace MMI
} // namespace OHOS
#endif // KEY_GESTURE_MANAGER_H