/include/ui/VirtualKeyMap.h

 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 _UI_VIRTUAL_KEY_MAP_H
18#define _UI_VIRTUAL_KEY_MAP_H
19
20#include <stdint.h>
21
22#include <ui/Input.h>
23#include <utils/Errors.h>
24#include <utils/KeyedVector.h>
25#include <utils/Tokenizer.h>
26#include <utils/String8.h>
27#include <utils/Unicode.h>
28
29namespace android {
30
31/* Describes a virtual key. */
32struct 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 */
47class VirtualKeyMap {
48public:
49    ~VirtualKeyMap();
50
51    static status_t load(const String8& filename, VirtualKeyMap** outMap);
52
53    inline const Vector<VirtualKeyDefinition>& getVirtualKeys() const {
54        return mVirtualKeys;
55    }
56
57private:
58    class Parser {
59        VirtualKeyMap* mMap;
60        Tokenizer* mTokenizer;
61
62    public:
63        Parser(VirtualKeyMap* map, Tokenizer* tokenizer);
64        ~Parser();
65        status_t parse();
66
67    private:
68        bool consumeFieldDelimiterAndSkipWhitespace();
69        bool parseNextIntField(int32_t* outValue);
70    };
71
72    Vector<VirtualKeyDefinition> mVirtualKeys;
73
74    VirtualKeyMap();
75};
76
77} // namespace android
78
79#endif // _UI_KEY_CHARACTER_MAP_H