# inputmethod_imf

#### Introduction

Input Method Framework, is used to connect the application and input method. the application can input text through the input method

**图 1**  子系统架构图<a name="fig143011012341"></a>
![](figures/subsystem_architecture.png "子系统架构图")

#### Warehouse path

/base/inputmethod/imf

#### Introduction to framework code

The input method framework currently has four modules, as follows:

1. Application client

Path: /base/inputmethod/imf/frameworks/inputmethod_controller

Function: realize the service delivery of application and input method framework, including the binding between application and input method service, application display and hiding request for input method, etc

2. Input method client

Path: /base/inputmethod/imf/frameworks/inputmethod_ability

Function: the intermediate bridge between input method framework service and input method delivery, including monitoring the current status of input method, etc

3. Input method service

Path: /base/inputmethod/imf/services

Function: as the core of the input method framework, the main processing logic of the input method is completed here

4. Input method JS interface

Path: /base/inputmethod/imf/interfaces/kits/JS

Function: the temporarily exposed JS interface is mainly reserved for calling input methods

#### Main functions supported by the framework

1. Click in the edit attribute control to invoke the default input method application through the input method framework

2. Typing can be carried out through the input method application, and characters can be input to the application client on the screen

#### Debugging method

1.   Compile command

./build.sh --product-name (Fill in the specific product name, such as：Hi3516DV300) --build-target imf

2.  push so file

in $root\out\ohos-arm-release\inputmethod\imf, push libinputmethod_client.z.so libinputmethod_ability.z.so
libinputmethod_service.z.so libinputmethod_para.z.so to system/lib，and push libinputmethodengine.z.so libinputmethod.z.so to system/lib/module， and make sure the six so files is readable at least.

3.  reboot

#### Participation contribution

1. Fork warehouse
2. Submission code
3. Create a new pull request
4. Commit is complete

# inputmethod_imf

#### 介绍
输入法框架，主要作用是拉通应用和输入法，保证应用可以通过输入法进行文本输入

**图 1**  子系统架构图<a name="fig143011012341"></a>
![](figures/subsystem_architecture_zh.png "子系统架构图")

#### 仓路径
/base/inputmethod/imf

## 目录

```
/base/inputmethod/imf
├── figures                                     # 构架图
├── frameworks
│   └── js/napi                                 # 输入法框架napi接口
│   └── native
│       └──inputmethod_ability                  # 对输入法客户端提供的接口
│       └──inputmethod_controller               # 对客户端提供的接口
├── interfaces                                  # 组件对外提供的接口代码
│   └── inner_api                               # innerApi接口
├── profile                                     # 组件包含的系统服务的配置文件和进程的配置文件
├── services                                    # 输入法框架服务
├── test                                        # 接口的Fuzz测试和js单元测试
└── unitest                                     # 接口的单元测试
```

## 框架代码介绍
输入法框架目前有四大模块，具体如下：

1.  应用客户端

路径：/base/inputmethod/imf/frameworks/native/inputmethod_controller

作用：实现应用和输入法框架服务交付，包括应用与输入法服务的绑定、应用对输入法的显示和隐藏请求等等

2.  输入法客户端

路径：/base/inputmethod/imf/frameworks/native/inputmethod_ability

作用：实现输入法框架服务与输入法交付的中间桥梁，包括监听输入法当前的状态等等

3.  输入法服务

路径：/base/inputmethod/imf/services

作用：作为输入法框架的核心，输入法的主要处理逻辑都是在这里完成

4.  输入法Js接口

路径：/base/inputmethod/imf/frameworks/js

作用：暂时对外暴露的js接口，主要是留给输入法进行调用使用的


## 本框架编译调试方法

1.   编译命令

./build.sh --product-name (填写具体的产品名，如：Hi3516DV300) --build-target imf

2.  推送so文件

将工程目录下out\ohos-arm-release\inputmethod\imf 下的libinputmethod_client.z.so libinputmethod_ability.z.so
libinputmethod_service.z.so libinputmethod_para.z.so推送到system/lib，将libinputmethodengine.z.so libinputmethod.z.so 推送到system/lib/module下，并确保六个so至少为可读状态。

3.  重启设备

## 参与贡献

1.  Fork 本仓库
2.  提交代码
3.  新建 Pull Request
4.  commit完成即可