• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 #include <cstdint>
20 #include <list>
21 #include <memory>
22 #include <optional>
23 #include <string>
24 #include <unordered_map>
25 #include <utility>
26 #include <vector>
27 
28 #include <EventHub.h>
29 #include <InputDevice.h>
30 #include <InputReaderBase.h>
31 #include <InputReaderContext.h>
32 #include <NotifyArgs.h>
33 #include <PointerChoreographerPolicyInterface.h>
34 #include <StylusState.h>
35 #include <VibrationElement.h>
36 #include <android-base/logging.h>
37 #include <android-base/result.h>
38 #include <gmock/gmock.h>
39 #include <input/InputDevice.h>
40 #include <input/KeyCharacterMap.h>
41 #include <input/KeyLayoutMap.h>
42 #include <input/KeyboardClassifier.h>
43 #include <input/PropertyMap.h>
44 #include <input/TouchVideoFrame.h>
45 #include <input/VirtualKeyMap.h>
46 #include <utils/Errors.h>
47 #include <utils/Timers.h>
48 
49 namespace android {
50 
51 class MockInputReaderContext : public InputReaderContext {
52 public:
dump()53     std::string dump() override { return "(dump from MockInputReaderContext)"; }
54 
55     MOCK_METHOD(void, updateGlobalMetaState, (), (override));
56     MOCK_METHOD(int32_t, getGlobalMetaState, (), (override));
57 
58     MOCK_METHOD(void, disableVirtualKeysUntil, (nsecs_t time), (override));
59     MOCK_METHOD(bool, shouldDropVirtualKey, (nsecs_t now, int32_t keyCode, int32_t scanCode),
60                 (override));
61 
62     MOCK_METHOD(void, requestTimeoutAtTime, (nsecs_t when), (override));
bumpGeneration()63     int32_t bumpGeneration() override { return ++mGeneration; }
64 
65     MOCK_METHOD(void, getExternalStylusDevices, (std::vector<InputDeviceInfo>& outDevices),
66                 (override));
67     MOCK_METHOD(std::list<NotifyArgs>, dispatchExternalStylusState, (const StylusState& outState),
68                 (override));
69 
70     MOCK_METHOD(InputReaderPolicyInterface*, getPolicy, (), (override));
71     MOCK_METHOD(EventHubInterface*, getEventHub, (), (override));
72 
getNextId()73     int32_t getNextId() const override { return 1; };
74 
75     MOCK_METHOD(void, updateLedMetaState, (int32_t metaState), (override));
76     MOCK_METHOD(int32_t, getLedMetaState, (), (override));
77 
78     MOCK_METHOD(void, setPreventingTouchpadTaps, (bool prevent), (override));
79     MOCK_METHOD(bool, isPreventingTouchpadTaps, (), (override));
80 
81     MOCK_METHOD(void, setLastKeyDownTimestamp, (nsecs_t when));
82     MOCK_METHOD(nsecs_t, getLastKeyDownTimestamp, ());
83 
getKeyboardClassifier()84     KeyboardClassifier& getKeyboardClassifier() override { return *mClassifier; };
85 
86 private:
87     int32_t mGeneration = 0;
88     std::unique_ptr<KeyboardClassifier> mClassifier = std::make_unique<KeyboardClassifier>();
89 };
90 
91 class MockEventHubInterface : public EventHubInterface {
92 public:
93     MOCK_METHOD(ftl::Flags<InputDeviceClass>, getDeviceClasses, (int32_t deviceId), (const));
94     MOCK_METHOD(InputDeviceIdentifier, getDeviceIdentifier, (int32_t deviceId), (const));
95     MOCK_METHOD(int32_t, getDeviceControllerNumber, (int32_t deviceId), (const));
96     MOCK_METHOD(std::optional<PropertyMap>, getConfiguration, (int32_t deviceId), (const));
97     MOCK_METHOD(std::optional<RawAbsoluteAxisInfo>, getAbsoluteAxisInfo,
98                 (int32_t deviceId, int axis), (const));
99     MOCK_METHOD(bool, hasRelativeAxis, (int32_t deviceId, int axis), (const));
100     MOCK_METHOD(bool, hasInputProperty, (int32_t deviceId, int property), (const));
101     MOCK_METHOD(bool, hasMscEvent, (int32_t deviceId, int mscEvent), (const));
102     MOCK_METHOD(void, setKeyRemapping,
103                 (int32_t deviceId, (const std::map<int32_t, int32_t>& keyRemapping)), (const));
104     MOCK_METHOD(status_t, mapKey,
105                 (int32_t deviceId, int scanCode, int usageCode, int32_t metaState,
106                  int32_t* outKeycode, int32_t* outMetaState, uint32_t* outFlags),
107                 (const));
108     MOCK_METHOD(status_t, mapAxis, (int32_t deviceId, int scanCode, AxisInfo* outAxisInfo),
109                 (const));
110     MOCK_METHOD(void, setExcludedDevices, (const std::vector<std::string>& devices));
111     MOCK_METHOD(std::vector<RawEvent>, getEvents, (int timeoutMillis));
112     MOCK_METHOD(std::vector<TouchVideoFrame>, getVideoFrames, (int32_t deviceId));
113     MOCK_METHOD((base::Result<std::pair<InputDeviceSensorType, int32_t>>), mapSensor,
114                 (int32_t deviceId, int32_t absCode), (const, override));
115     MOCK_METHOD(std::vector<int32_t>, getRawBatteryIds, (int32_t deviceId), (const, override));
116     MOCK_METHOD(std::optional<RawBatteryInfo>, getRawBatteryInfo,
117                 (int32_t deviceId, int32_t BatteryId), (const, override));
118     MOCK_METHOD(std::vector<int32_t>, getRawLightIds, (int32_t deviceId), (const, override));
119     MOCK_METHOD(std::optional<RawLightInfo>, getRawLightInfo, (int32_t deviceId, int32_t lightId),
120                 (const, override));
121     MOCK_METHOD(std::optional<int32_t>, getLightBrightness, (int32_t deviceId, int32_t lightId),
122                 (const, override));
123     MOCK_METHOD(void, setLightBrightness, (int32_t deviceId, int32_t lightId, int32_t brightness),
124                 (override));
125     MOCK_METHOD((std::optional<std::unordered_map<LightColor, int32_t>>), getLightIntensities,
126                 (int32_t deviceId, int32_t lightId), (const, override));
127     MOCK_METHOD(void, setLightIntensities,
128                 (int32_t deviceId, int32_t lightId,
129                  (std::unordered_map<LightColor, int32_t>)intensities),
130                 (override));
131 
132     MOCK_METHOD(std::optional<RawLayoutInfo>, getRawLayoutInfo, (int32_t deviceId),
133                 (const, override));
134     MOCK_METHOD(int32_t, getScanCodeState, (int32_t deviceId, int32_t scanCode), (const, override));
135     MOCK_METHOD(int32_t, getKeyCodeState, (int32_t deviceId, int32_t keyCode), (const, override));
136     MOCK_METHOD(int32_t, getSwitchState, (int32_t deviceId, int32_t sw), (const, override));
137 
138     MOCK_METHOD(std::optional<int32_t>, getAbsoluteAxisValue, (int32_t deviceId, int32_t axis),
139                 (const, override));
140     MOCK_METHOD(base::Result<std::vector<int32_t>>, getMtSlotValues,
141                 (int32_t deviceId, int32_t axis, size_t slotCount), (const, override));
142 
143     MOCK_METHOD(int32_t, getKeyCodeForKeyLocation, (int32_t deviceId, int32_t locationKeyCode),
144                 (const, override));
145     MOCK_METHOD(bool, markSupportedKeyCodes,
146                 (int32_t deviceId, const std::vector<int32_t>& keyCodes, uint8_t* outFlags),
147                 (const, override));
148 
149     MOCK_METHOD(bool, hasScanCode, (int32_t deviceId, int32_t scanCode), (const, override));
150 
151     MOCK_METHOD(bool, hasKeyCode, (int32_t deviceId, int32_t keyCode), (const, override));
152 
153     MOCK_METHOD(bool, hasLed, (int32_t deviceId, int32_t led), (const, override));
154 
155     MOCK_METHOD(void, setLedState, (int32_t deviceId, int32_t led, bool on), (override));
156 
157     MOCK_METHOD(void, getVirtualKeyDefinitions,
158                 (int32_t deviceId, std::vector<VirtualKeyDefinition>& outVirtualKeys),
159                 (const, override));
160 
161     MOCK_METHOD(const std::shared_ptr<KeyCharacterMap>, getKeyCharacterMap, (int32_t deviceId),
162                 (const, override));
163 
164     MOCK_METHOD(bool, setKeyboardLayoutOverlay,
165                 (int32_t deviceId, std::shared_ptr<KeyCharacterMap> map), (override));
166 
167     MOCK_METHOD(void, vibrate, (int32_t deviceId, const VibrationElement& effect), (override));
168     MOCK_METHOD(void, cancelVibrate, (int32_t deviceId), (override));
169 
170     MOCK_METHOD(std::vector<int32_t>, getVibratorIds, (int32_t deviceId), (const, override));
171     MOCK_METHOD(std::optional<int32_t>, getBatteryCapacity, (int32_t deviceId, int32_t batteryId),
172                 (const, override));
173 
174     MOCK_METHOD(std::optional<int32_t>, getBatteryStatus, (int32_t deviceId, int32_t batteryId),
175                 (const, override));
176     MOCK_METHOD(void, requestReopenDevices, (), (override));
177     MOCK_METHOD(void, wake, (), (override));
178 
179     MOCK_METHOD(void, dump, (std::string& dump), (const, override));
180     MOCK_METHOD(void, monitor, (), (const, override));
181     MOCK_METHOD(bool, isDeviceEnabled, (int32_t deviceId), (const, override));
182     MOCK_METHOD(status_t, enableDevice, (int32_t deviceId), (override));
183     MOCK_METHOD(status_t, disableDevice, (int32_t deviceId), (override));
184     MOCK_METHOD(std::filesystem::path, getSysfsRootPath, (int32_t deviceId), (const, override));
185     MOCK_METHOD(void, sysfsNodeChanged, (const std::string& sysfsNodePath), (override));
186     MOCK_METHOD(bool, setKernelWakeEnabled, (int32_t deviceId, bool enabled), (override));
187 };
188 
189 class MockPointerChoreographerPolicyInterface : public PointerChoreographerPolicyInterface {
190 public:
191     MOCK_METHOD(std::shared_ptr<PointerControllerInterface>, createPointerController,
192                 (PointerControllerInterface::ControllerType), (override));
193     MOCK_METHOD(void, notifyPointerDisplayIdChanged,
194                 (ui::LogicalDisplayId displayId, const vec2& position), (override));
195     MOCK_METHOD(bool, isInputMethodConnectionActive, (), (override));
196     MOCK_METHOD(void, notifyMouseCursorFadedOnTyping, (), (override));
197     MOCK_METHOD(std::optional<vec2>, filterPointerMotionForAccessibility,
198                 (const vec2& current, const vec2& delta, const ui::LogicalDisplayId& displayId),
199                 (override));
200 };
201 
202 class MockInputDevice : public InputDevice {
203 public:
MockInputDevice(InputReaderContext * context,int32_t id,int32_t generation,const InputDeviceIdentifier & identifier,bool isExternal)204     MockInputDevice(InputReaderContext* context, int32_t id, int32_t generation,
205                     const InputDeviceIdentifier& identifier, bool isExternal)
206           : InputDevice(context, id, generation, identifier), mIsExternal(isExternal) {}
207 
208     MOCK_METHOD(uint32_t, getSources, (), (const, override));
209     MOCK_METHOD(std::optional<DisplayViewport>, getAssociatedViewport, (), (const));
210     MOCK_METHOD(KeyboardType, getKeyboardType, (), (const, override));
211     MOCK_METHOD(bool, isEnabled, (), ());
isExternal()212     bool isExternal() override { return mIsExternal; }
213 
214     MOCK_METHOD(void, dump, (std::string& dump, const std::string& eventHubDevStr), ());
215     MOCK_METHOD(void, addEmptyEventHubDevice, (int32_t eventHubId), ());
216     MOCK_METHOD(std::list<NotifyArgs>, addEventHubDevice,
217                 (nsecs_t when, int32_t eventHubId, const InputReaderConfiguration& readerConfig),
218                 ());
219     MOCK_METHOD(void, removeEventHubDevice, (int32_t eventHubId), ());
220     MOCK_METHOD(std::list<NotifyArgs>, configure,
221                 (nsecs_t when, const InputReaderConfiguration& readerConfig,
222                  ConfigurationChanges changes),
223                 ());
224     MOCK_METHOD(std::list<NotifyArgs>, reset, (nsecs_t when), ());
225     MOCK_METHOD(std::list<NotifyArgs>, process, (const RawEvent* rawEvents, size_t count), ());
226     MOCK_METHOD(std::list<NotifyArgs>, timeoutExpired, (nsecs_t when), ());
227     MOCK_METHOD(std::list<NotifyArgs>, updateExternalStylusState, (const StylusState& state), ());
228 
229     MOCK_METHOD(InputDeviceInfo, getDeviceInfo, (), ());
230     MOCK_METHOD(int32_t, getKeyCodeState, (uint32_t sourceMask, int32_t keyCode), ());
231     MOCK_METHOD(int32_t, getScanCodeState, (uint32_t sourceMask, int32_t scanCode), ());
232     MOCK_METHOD(int32_t, getSwitchState, (uint32_t sourceMask, int32_t switchCode), ());
233     MOCK_METHOD(int32_t, getKeyCodeForKeyLocation, (int32_t locationKeyCode), (const));
234     MOCK_METHOD(bool, markSupportedKeyCodes,
235                 (uint32_t sourceMask, const std::vector<int32_t>& keyCodes, uint8_t* outFlags), ());
236     MOCK_METHOD(std::list<NotifyArgs>, vibrate,
237                 (const VibrationSequence& sequence, ssize_t repeat, int32_t token), ());
238     MOCK_METHOD(std::list<NotifyArgs>, cancelVibrate, (int32_t token), ());
239     MOCK_METHOD(bool, isVibrating, (), ());
240     MOCK_METHOD(std::vector<int32_t>, getVibratorIds, (), ());
241     MOCK_METHOD(std::list<NotifyArgs>, cancelTouch, (nsecs_t when, nsecs_t readTime), ());
242     MOCK_METHOD(bool, enableSensor,
243                 (InputDeviceSensorType sensorType, std::chrono::microseconds samplingPeriod,
244                  std::chrono::microseconds maxBatchReportLatency),
245                 ());
246 
247     MOCK_METHOD(void, disableSensor, (InputDeviceSensorType sensorType), ());
248     MOCK_METHOD(void, flushSensor, (InputDeviceSensorType sensorType), ());
249 
250     MOCK_METHOD(std::optional<int32_t>, getBatteryEventHubId, (), (const));
251 
252     MOCK_METHOD(bool, setLightColor, (int32_t lightId, int32_t color), ());
253     MOCK_METHOD(bool, setLightPlayerId, (int32_t lightId, int32_t playerId), ());
254     MOCK_METHOD(std::optional<int32_t>, getLightColor, (int32_t lightId), ());
255     MOCK_METHOD(std::optional<int32_t>, getLightPlayerId, (int32_t lightId), ());
256 
257     MOCK_METHOD(int32_t, getMetaState, (), ());
258     MOCK_METHOD(void, setKeyboardType, (KeyboardType keyboardType), ());
259 
260     MOCK_METHOD(const PropertyMap&, getConfiguration, (), (const, override));
261 
262     MOCK_METHOD(NotifyDeviceResetArgs, notifyReset, (nsecs_t when), ());
263 
264     MOCK_METHOD(std::optional<ui::LogicalDisplayId>, getAssociatedDisplayId, (), ());
265 
266     MOCK_METHOD(void, updateLedState, (bool reset), ());
267 
268     MOCK_METHOD(size_t, getMapperCount, (), ());
269 
getGeneration()270     virtual int32_t getGeneration() const override { return mGeneration; }
bumpGeneration()271     virtual void bumpGeneration() override { mGeneration++; }
272 
273 private:
274     int32_t mGeneration = 0;
275     const bool mIsExternal;
276 };
277 } // namespace android
278