MaaFramework/include/MaaControlUnit/ControlUnitAPI.h at 593dfde7980054440712a37ce0852b450e46829e · ZeroAd-06/MaaFramework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
#pragma once

#include <chrono>
#include <string>
#include <utility>

#include <meojson/json.hpp>

#include <opencv2/core/mat.hpp>

#include "MaaControlUnit/MaaControlUnitDef.h"
#include "MaaFramework/MaaDef.h"

MAA_CTRL_UNIT_NS_BEGIN

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

    virtual bool connect() = 0;
    virtual bool connected() const = 0;

    virtual bool request_uuid(/*out*/ std::string& uuid) = 0;
    virtual MaaControllerFeature get_features() const = 0;

    virtual bool start_app(const std::string& intent) = 0;
    virtual bool stop_app(const std::string& intent) = 0;

    virtual bool screencap(/*out*/ cv::Mat& image) = 0;

    virtual bool click(int x, int y) = 0;
    virtual bool swipe(int x1, int y1, int x2, int y2, int duration) = 0;

    virtual bool touch_down(int contact, int x, int y, int pressure) = 0;
    virtual bool touch_move(int contact, int x, int y, int pressure) = 0;
    virtual bool touch_up(int contact) = 0;

    virtual bool click_key(int key) = 0;
    virtual bool input_text(const std::string& text) = 0;

    virtual bool key_down(int key) = 0;
    virtual bool key_up(int key) = 0;

    virtual bool inactive() = 0;

    virtual json::object get_info() const = 0;
};

// Capability mixins: optional interfaces that controllers may support

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

    virtual bool scroll(int dx, int dy) = 0;
};

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

    virtual bool relative_move(int dx, int dy) = 0;
};

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

    virtual bool
        shell(const std::string& cmd, std::string& output, std::chrono::milliseconds timeout = std::chrono::milliseconds(20000)) = 0;
};

// Platform-specific APIs, composed from base + capability mixins

class AdbControlUnitAPI
    : public ControlUnitAPI
    , public ShellableUnit
{
public:
    virtual ~AdbControlUnitAPI() = default;

    virtual bool find_device(/*out*/ std::vector<std::string>& devices) = 0;
};

class AndroidNativeControlUnitAPI : public ControlUnitAPI
{
public:
    ~AndroidNativeControlUnitAPI() override = default;
};

class Win32ControlUnitAPI
    : public ControlUnitAPI
    , public ScrollableUnit
    , public RelativeMovableUnit
{
public:
    virtual ~Win32ControlUnitAPI() = default;

    virtual bool set_mouse_lock_follow(bool /*enabled*/) { return false; }
    virtual bool set_background_managed_keys_option(const int32_t* /*keycodes*/, size_t /*count*/) { return false; }
};

class MacOSControlUnitAPI
    : public ControlUnitAPI
    , public ScrollableUnit
    , public RelativeMovableUnit
{
public:
    virtual ~MacOSControlUnitAPI() = default;
};

class WlRootsControlUnitAPI
    : public ControlUnitAPI
    , public ScrollableUnit
    , public RelativeMovableUnit
{
public:
    virtual ~WlRootsControlUnitAPI() = default;
};

class CustomControlUnitAPI
    : public ControlUnitAPI
    , public ScrollableUnit
    , public RelativeMovableUnit
    , public ShellableUnit
{
public:
    virtual ~CustomControlUnitAPI() = default;
};

class GamepadControlUnitAPI : public ControlUnitAPI
{
public:
    virtual ~GamepadControlUnitAPI() = default;
};

class FullControlUnitAPI
    : public ControlUnitAPI
    , public ScrollableUnit
    , public RelativeMovableUnit
    , public ShellableUnit
{
public:
    virtual ~FullControlUnitAPI() = default;
};

MAA_CTRL_UNIT_NS_END

using MaaControlUnitHandle = MAA_CTRL_UNIT_NS::ControlUnitAPI*;
using MaaAdbControlUnitHandle = MAA_CTRL_UNIT_NS::AdbControlUnitAPI*;
using MaaWin32ControlUnitHandle = MAA_CTRL_UNIT_NS::Win32ControlUnitAPI*;
using MaaMacOSControlUnitHandle = MAA_CTRL_UNIT_NS::MacOSControlUnitAPI*;
using MaaWlRootsControlUnitHandle = MAA_CTRL_UNIT_NS::WlRootsControlUnitAPI*;
using MaaGamepadControlUnitHandle = MAA_CTRL_UNIT_NS::GamepadControlUnitAPI*;
using MaaCustomControlUnitHandle = MAA_CTRL_UNIT_NS::CustomControlUnitAPI*;
using MaaReplayControlUnitHandle = MAA_CTRL_UNIT_NS::FullControlUnitAPI*;
using MaaRecordControlUnitHandle = MAA_CTRL_UNIT_NS::FullControlUnitAPI*;
using MaaDbgControlUnitHandle = MAA_CTRL_UNIT_NS::ControlUnitAPI*;
using MaaAndroidNativeControlUnitHandle = MAA_CTRL_UNIT_NS::AndroidNativeControlUnitAPI*;