1 /*
2  * Copyright (C) 2015 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 package android.widget.espresso;
18 
19 import android.view.InputDevice;
20 import android.view.MotionEvent;
21 import android.view.View;
22 import android.view.ViewConfiguration;
23 
24 import androidx.test.espresso.UiController;
25 import androidx.test.espresso.ViewAction;
26 import androidx.test.espresso.action.CoordinatesProvider;
27 import androidx.test.espresso.action.MotionEvents;
28 import androidx.test.espresso.action.MotionEvents.DownResultHolder;
29 import androidx.test.espresso.action.Press;
30 import androidx.test.espresso.action.Tapper;
31 
32 import org.hamcrest.Matcher;
33 
34 /**
35  * ViewAction for performing an click on View by a mouse.
36  */
37 public final class MouseClickAction implements ViewAction {
38     private final ViewClickAction mViewClickAction;
39     @MouseUiController.MouseButton
40     private final int mButton;
41 
42     public enum CLICK implements Tapper {
43         TRIPLE {
44             @Override
sendTap(UiController uiController, float[] coordinates, float[] precision, int inputDevice, int buttonState)45             public Tapper.Status sendTap(UiController uiController, float[] coordinates,
46                     float[] precision, int inputDevice, int buttonState) {
47                 Tapper.Status stat = sendSingleTap(uiController, coordinates, precision,
48                         inputDevice, buttonState);
49                 boolean warning = false;
50                 if (stat == Tapper.Status.FAILURE) {
51                     return Tapper.Status.FAILURE;
52                 } else if (stat == Tapper.Status.WARNING) {
53                     warning = true;
54                 }
55 
56                 long doubleTapMinimumTimeout = ViewConfiguration.getDoubleTapMinTime();
57                 for (int i = 0; i < 2; i++) {
58                     if (0 < doubleTapMinimumTimeout) {
59                         uiController.loopMainThreadForAtLeast(doubleTapMinimumTimeout);
60                     }
61                     stat = sendSingleTap(uiController, coordinates, precision, inputDevice,
62                             buttonState);
63                     if (stat == Tapper.Status.FAILURE) {
64                         return Tapper.Status.FAILURE;
65                     } else if (stat == Tapper.Status.WARNING) {
66                         warning = true;
67                     }
68                 }
69 
70                 if (warning) {
71                     return Tapper.Status.WARNING;
72                 } else {
73                     return Tapper.Status.SUCCESS;
74                 }
75             }
76 
77             @Override
sendTap(UiController uiController, float[] coordinates, float[] precision)78             public Tapper.Status sendTap(UiController uiController, float[] coordinates,
79                     float[] precision) {
80                 return sendTap(uiController, coordinates, precision, InputDevice.SOURCE_UNKNOWN,
81                         MotionEvent.BUTTON_PRIMARY);
82             }
83         };
84 
sendSingleTap(UiController uiController, float[] coordinates, float[] precision, int inputDevice, int buttonState)85         private static Tapper.Status sendSingleTap(UiController uiController,
86                 float[] coordinates, float[] precision, int inputDevice, int buttonState) {
87             DownResultHolder res = MotionEvents.sendDown(uiController, coordinates, precision,
88                     inputDevice, buttonState);
89             try {
90                 if (!MotionEvents.sendUp(uiController, res.down)) {
91                     MotionEvents.sendCancel(uiController, res.down);
92                     return Tapper.Status.FAILURE;
93                 }
94             } finally {
95                 res.down.recycle();
96             }
97             return res.longPress ? Tapper.Status.WARNING : Tapper.Status.SUCCESS;
98         }
99     };
100 
MouseClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider)101     public MouseClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider) {
102         this(tapper, coordinatesProvider, MotionEvent.BUTTON_PRIMARY);
103     }
104 
105     /**
106      * Constructs MouseClickAction
107      *
108      * @param tapper the tapper
109      * @param coordinatesProvider the provider of the event coordinates
110      * @param button the mouse button used to send motion events
111      */
MouseClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider, @MouseUiController.MouseButton int button)112     public MouseClickAction(Tapper tapper, CoordinatesProvider coordinatesProvider,
113             @MouseUiController.MouseButton int button) {
114         mViewClickAction = new ViewClickAction(tapper, coordinatesProvider, Press.PINPOINT);
115         mButton = button;
116     }
117 
118     @Override
getConstraints()119     public Matcher<View> getConstraints() {
120         return mViewClickAction.getConstraints();
121     }
122 
123     @Override
getDescription()124     public String getDescription() {
125         return mViewClickAction.getDescription();
126     }
127 
128     @Override
perform(UiController uiController, View view)129     public void perform(UiController uiController, View view) {
130         mViewClickAction.perform(new MouseUiController(uiController, mButton), view);
131     }
132 }
133