1 <html devsite> 2 <head> 3 <title>Validate Keymaps Tool</title> 4 <meta name="project_path" value="/_project.yaml" /> 5 <meta name="book_path" value="/_book.yaml" /> 6 </head> 7 <body> 8 <!-- 9 Copyright 2017 The Android Open Source Project 10 11 Licensed under the Apache License, Version 2.0 (the "License"); 12 you may not use this file except in compliance with the License. 13 You may obtain a copy of the License at 14 15 http://www.apache.org/licenses/LICENSE-2.0 16 17 Unless required by applicable law or agreed to in writing, software 18 distributed under the License is distributed on an "AS IS" BASIS, 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20 See the License for the specific language governing permissions and 21 limitations under the License. 22 --> 23 24 25 26 <p>The Android framework has a small tool called <code>validatekeymaps</code> to validate the 27 syntax of input device configuration files, key layout files, key character 28 maps files and virtual key definition files.</p> 29 <h2 id="compilation">Compilation</h2> 30 <p>To compile <code>validatekeymaps</code>, set up the development environment, download 31 the Android source tree, compile it, then run:</p> 32 <pre class="devsite-terminal devsite-click-to-copy"> 33 mmm frameworks/base/tools/validatekeymaps 34 </pre> 35 <p>This command should compile a host tool called validatekeymaps into the 36 <code>out/host/<os>/bin</code> directory.</p> 37 <h2 id="usage">Usage</h2> 38 <p>If you ran <code>envsetup.sh</code> to set up your development environment, then the 39 <code>validatekeymaps</code> tool should already be on your path. You can verify 40 this by running <code>validatekeymaps</code>.</p> 41 <pre class="devsite-terminal devsite-click-to-copy"> 42 validatekeymaps 43 </pre> 44 <p>You should see the following output:</p> 45 <pre> 46 Keymap Validation Tool 47 48 Usage: 49 validatekeymaps [*.kl] [*.kcm] [*.idc] [virtualkeys.*] [...] 50 Validates the specified key layouts, key character maps, 51 input device configurations, or virtual key definitions. 52 </pre> 53 <p>Then all you need to do is run <code>validatekeymaps</code> and give it the path of 54 one or more files to validate.</p> 55 <pre class="devsite-terminal devsite-click-to-copy"> 56 validatekeymaps frameworks/base/data/keyboards/Generic.kl 57 </pre> 58 <p>Example:</p> 59 <pre> 60 Validating file 'frameworks/base/data/keyboards/Generic.kl'... 61 No errors. 62 63 Success. 64 </pre> 65 <p>And if there is an error...</p> 66 <pre class="devsite-terminal devsite-click-to-copy"> 67 validatekeymaps Bad.kl 68 </pre> 69 <p>Example:</p> 70 <pre> 71 Validating file 'Bad.kl'... 72 E/KeyLayoutMap(87688): Bad.kl:24: Expected keyword, got 'ke'. 73 Error -22 parsing key layout file. 74 75 Failed! 76 </pre> 77 <h2 id="automation">Automation</h2> 78 <p>It is a <em>very</em> good idea to run <code>validatekeymaps</code> on all configuration files 79 before installing them on a device.</p> 80 <p>The process can easily be automated as part of the build system by using a 81 script or a makefile.</p> 82 <p>The following sample makefile is based on the contents of 83 <code>frameworks/base/data/keyboards/Android.mk</code>.</p> 84 <pre class="devsite-click-to-copy"> 85 # This makefile performs build time validation of framework keymap files. 86 87 LOCAL_PATH := $(call my-dir) 88 89 # Validate all key maps. 90 include $(CLEAR_VARS) 91 92 validatekeymaps := $(HOST_OUT_EXECUTABLES)/validatekeymaps$(HOST_EXECUTABLE_SUFFIX) 93 files := MyKeyboard.kl MyKeyboard.kcm MyTouchScreen.idc 94 95 LOCAL_MODULE := validate_framework_keymaps 96 LOCAL_MODULE_TAGS := optional 97 LOCAL_REQUIRED_MODULES := validatekeymaps 98 99 validate_framework_keymaps: $(files) 100 $(hide) $(validatekeymaps) $(files) 101 102 include $(BUILD_PHONY_PACKAGE) 103 </pre> 104 105 </body> 106 </html> 107
