1 /*
2  * Copyright (C) 2010 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 #ifndef _LIBINPUT_VIRTUAL_KEY_MAP_H
18 #define _LIBINPUT_VIRTUAL_KEY_MAP_H
19 
20 #include <stdint.h>
21 
22 #include <input/Input.h>
23 #include <utils/Errors.h>
24 #include <utils/KeyedVector.h>
25 #include <utils/Tokenizer.h>
26 #include <utils/Unicode.h>
27 #include <vector>
28 
29 namespace android {
30 
31 /* Describes a virtual key. */
32 struct VirtualKeyDefinition {
33     int32_t scanCode;
34 
35     // configured position data, specified in display coords
36     int32_t centerX;
37     int32_t centerY;
38     int32_t width;
39     int32_t height;
40 };
41 
42 
43 /**
44  * Describes a collection of virtual keys on a touch screen in terms of
45  * virtual scan codes and hit rectangles.
46  *
47  * This object is immutable after it has been loaded.
48  */
49 class VirtualKeyMap {
50 public:
51     ~VirtualKeyMap();
52 
53     static std::unique_ptr<VirtualKeyMap> load(const std::string& filename);
54 
getVirtualKeys()55     inline const std::vector<VirtualKeyDefinition>& getVirtualKeys() const {
56         return mVirtualKeys;
57     }
58 
59 private:
60     class Parser {
61         VirtualKeyMap* mMap;
62         Tokenizer* mTokenizer;
63 
64     public:
65         Parser(VirtualKeyMap* map, Tokenizer* tokenizer);
66         ~Parser();
67         status_t parse();
68 
69     private:
70         bool consumeFieldDelimiterAndSkipWhitespace();
71         bool parseNextIntField(int32_t* outValue);
72     };
73 
74     std::vector<VirtualKeyDefinition> mVirtualKeys;
75 
76     VirtualKeyMap();
77 };
78 
79 } // namespace android
80 
81 #endif // _LIBINPUT_KEY_CHARACTER_MAP_H
82