Gamepad API - Deprecate the existing implementation
[WebKit-https.git] / Source / WebCore / platform / efl / GamepadsEfl.cpp
1 /*
2  * Copyright (C) 2012 Intel Corporation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "Gamepads.h"
28
29 #if ENABLE(GAMEPAD_DEPRECATED)
30
31 #include "GamepadDeviceLinux.h"
32 #include "GamepadList.h"
33 #include "Logging.h"
34 #include <Ecore.h>
35 #include <Eeze.h>
36 #include <Eina.h>
37 #include <unistd.h>
38 #include <wtf/HashMap.h>
39 #include <wtf/NeverDestroyed.h>
40 #include <wtf/PassOwnPtr.h>
41 #include <wtf/text/CString.h>
42 #include <wtf/text/StringHash.h>
43
44 namespace WebCore {
45
46 static const char joystickPrefix[] = "/dev/input/js";
47
48 class GamepadDeviceEfl : public GamepadDeviceLinux {
49 public:
50     static PassOwnPtr<GamepadDeviceEfl> create(const String& deviceFile)
51     {
52         return adoptPtr(new GamepadDeviceEfl(deviceFile));
53     }
54     ~GamepadDeviceEfl();
55     void resetFdHandler() { m_fdHandler = 0; }
56     const String& deviceFile() const { return m_deviceFile; }
57
58 private:
59     GamepadDeviceEfl(const String& deviceFile);
60     static Eina_Bool readCallback(void* userData, Ecore_Fd_Handler*);
61
62     Ecore_Fd_Handler* m_fdHandler;
63     String m_deviceFile;
64 };
65
66 GamepadDeviceEfl::GamepadDeviceEfl(const String& deviceFile)
67     : GamepadDeviceLinux(deviceFile)
68     , m_fdHandler(0)
69     , m_deviceFile(deviceFile)
70 {
71     if (m_fileDescriptor < 0)
72         return;
73
74     m_fdHandler = ecore_main_fd_handler_add(m_fileDescriptor, ECORE_FD_READ, readCallback, this, 0, 0);
75     if (!m_fdHandler)
76         LOG_ERROR("Failed to create the Ecore_Fd_Handler.");
77 }
78
79 GamepadDeviceEfl::~GamepadDeviceEfl()
80 {
81     if (m_fdHandler)
82         ecore_main_fd_handler_del(m_fdHandler);
83 }
84
85 Eina_Bool GamepadDeviceEfl::readCallback(void* userData, Ecore_Fd_Handler* fdHandler)
86 {
87     GamepadDeviceEfl* gamepadDevice = static_cast<GamepadDeviceEfl*>(userData);
88
89     if (ecore_main_fd_handler_active_get(fdHandler, ECORE_FD_ERROR)) {
90         LOG_ERROR("An error occurred while watching the joystick file descriptor at %s, aborting.", gamepadDevice->deviceFile().utf8().data());
91         gamepadDevice->resetFdHandler();
92         return ECORE_CALLBACK_CANCEL;
93     }
94
95     int fdDevice = ecore_main_fd_handler_fd_get(fdHandler);
96     struct js_event event;
97     const ssize_t len = read(fdDevice, &event, sizeof(event));
98
99     if (len <= 0) {
100         LOG_ERROR("Failed to read joystick file descriptor at %s, aborting.", gamepadDevice->deviceFile().utf8().data());
101         gamepadDevice->resetFdHandler();
102         return ECORE_CALLBACK_CANCEL;
103     }
104     if (len != sizeof(event)) {
105         LOG_ERROR("Wrong js_event size read on file descriptor at %s, ignoring.", gamepadDevice->deviceFile().utf8().data());
106         return ECORE_CALLBACK_RENEW;
107     }
108
109     gamepadDevice->updateForEvent(event);
110     return ECORE_CALLBACK_RENEW;
111 }
112
113 class GamepadsEfl {
114     friend class NeverDestroyed<GamepadsEfl>;
115 public:
116     GamepadsEfl(size_t length);
117
118     void registerDevice(const String& syspath);
119     void unregisterDevice(const String& syspath);
120
121     void updateGamepadList(GamepadList*);
122
123 private:
124     ~GamepadsEfl();
125     static void onGamePadChange(const char* syspath, Eeze_Udev_Event, void* userData, Eeze_Udev_Watch* watcher);
126
127     Vector<OwnPtr<GamepadDeviceEfl> > m_slots;
128     HashMap<String, GamepadDeviceEfl*> m_deviceMap;
129
130     Eeze_Udev_Watch* m_gamepadsWatcher;
131 };
132
133 void GamepadsEfl::onGamePadChange(const char* syspath, Eeze_Udev_Event event, void* userData, Eeze_Udev_Watch*)
134 {
135     GamepadsEfl* gamepadsEfl = static_cast<GamepadsEfl*>(userData);
136
137     switch (event) {
138     case EEZE_UDEV_EVENT_ADD:
139         gamepadsEfl->registerDevice(String::fromUTF8(syspath));
140         break;
141     case EEZE_UDEV_EVENT_REMOVE:
142         gamepadsEfl->unregisterDevice(String::fromUTF8(syspath));
143         break;
144     default:
145         break;
146     }
147 }
148
149 GamepadsEfl::GamepadsEfl(size_t length)
150     : m_slots(length)
151     , m_gamepadsWatcher(0)
152 {
153     if (eeze_init() < 0) {
154         LOG_ERROR("Failed to initialize eeze library.");
155         return;
156     }
157
158     // Watch for gamepads additions / removals.
159     m_gamepadsWatcher = eeze_udev_watch_add(EEZE_UDEV_TYPE_JOYSTICK, (EEZE_UDEV_EVENT_ADD | EEZE_UDEV_EVENT_REMOVE), onGamePadChange, this);
160
161     // List available gamepads.
162     Eina_List* gamepads = eeze_udev_find_by_type(EEZE_UDEV_TYPE_JOYSTICK, 0);
163     void* data;
164     EINA_LIST_FREE(gamepads, data) {
165         char* syspath = static_cast<char*>(data);
166         registerDevice(String::fromUTF8(syspath));
167         eina_stringshare_del(syspath);
168     }
169 }
170
171 GamepadsEfl::~GamepadsEfl()
172 {
173     if (m_gamepadsWatcher)
174         eeze_udev_watch_del(m_gamepadsWatcher);
175     eeze_shutdown();
176 }
177
178 void GamepadsEfl::registerDevice(const String& syspath)
179 {
180     if (m_deviceMap.contains(syspath))
181         return;
182
183     // Make sure it is a valid joystick.
184     const char* deviceFile = eeze_udev_syspath_get_devpath(syspath.utf8().data());
185     if (!deviceFile || !eina_str_has_prefix(deviceFile, joystickPrefix))
186         return;
187
188     LOG(Gamepad, "Registering gamepad at %s", deviceFile);
189
190     const size_t slotCount = m_slots.size();
191     for (size_t index = 0; index < slotCount; ++index) {
192         if (!m_slots[index]) {
193             m_slots[index] = GamepadDeviceEfl::create(String::fromUTF8(deviceFile));
194             LOG(Gamepad, "Gamepad device name is %s", m_slots[index]->id().utf8().data());
195             m_deviceMap.add(syspath, m_slots[index].get());
196             break;
197         }
198     }
199 }
200
201 void GamepadsEfl::unregisterDevice(const String& syspath)
202 {
203     if (!m_deviceMap.contains(syspath))
204         return;
205
206     GamepadDeviceEfl* gamepadDevice = m_deviceMap.take(syspath);
207     LOG(Gamepad, "Unregistering gamepad at %s", gamepadDevice->deviceFile().utf8().data());
208     const size_t index = m_slots.find(gamepadDevice);
209     ASSERT(index != notFound);
210
211     m_slots[index].clear();
212 }
213
214 void GamepadsEfl::updateGamepadList(GamepadList* into)
215 {
216     ASSERT(m_slots.size() == into->length());
217
218     const size_t slotCount = m_slots.size();
219     for (size_t i = 0; i < slotCount; ++i) {
220         if (m_slots[i].get() && m_slots[i]->connected()) {
221             GamepadDeviceEfl* gamepadDevice = m_slots[i].get();
222             RefPtr<Gamepad> gamepad = into->item(i);
223             if (!gamepad)
224                 gamepad = Gamepad::create();
225
226             gamepad->index(i);
227             gamepad->id(gamepadDevice->id());
228             gamepad->timestamp(gamepadDevice->timestamp());
229             gamepad->axes(gamepadDevice->axesCount(), gamepadDevice->axesData());
230             gamepad->buttons(gamepadDevice->buttonsCount(), gamepadDevice->buttonsData());
231
232             into->set(i, gamepad);
233         } else
234             into->set(i, 0);
235     }
236 }
237
238 void sampleGamepads(GamepadList* into)
239 {
240     static NeverDestroyed<GamepadsEfl> gamepadsEfl(into->length());
241     gamepadsEfl.get().updateGamepadList(into);
242 }
243
244 } // namespace WebCore
245
246 #endif // ENABLE(GAMEPAD_DEPRECATED)