BeOS 中的输入法处理

SInputAwareStringView::SInputAwareStringView(BRect frame, const char *name, uint32 resizeMask, uint32 flags)
        : SStringView(frame, name, NULL, NULL, 0, NULL, resizeMask, flags), im_started(false)
{
        // 关键在这一行
        if(!(flags & B_INPUT_METHOD_AWARE)) SetFlags(flags | B_INPUT_METHOD_AWARE);
}

// 返回新分配的字符串，不再使用时用 free() 释放
char* get_key(int32 modifiers, int32 key_code)
{
        key_map *keys = NULL;
        char *chars = NULL;
        int32 offset = -1;
        char *retStr = NULL;

        if(key_code < 0 || key_code >= 128) return NULL;

        get_key_map(&keys, &chars);
        if(keys == NULL || chars == NULL)
        {
                if(keys) free(keys);
                if(chars) free(chars);
                return NULL;
        }

        if((modifiers & B_SHIFT_KEY) && (modifiers & B_CAPS_LOCK))
                offset = keys->caps_shift_map[key_code];
        else if(modifiers & B_SHIFT_KEY)
                offset = keys->shift_map[key_code];
        else if(modifiers & B_CAPS_LOCK)
                offset = keys->caps_map[key_code];
        else
                offset = keys->normal_map[key_code];

        if(!(offset < 0 || chars[offset] < 1))
        {
                if((retStr = (char*)malloc((size_t)chars[offset] + 1)) != NULL)
                {
                        memcpy(retStr, &(chars[offset + 1]), (size_t)chars[offset]);
                        *(retStr + chars[offset]) = 0;
                }
        }

        free(keys);
        free(chars);

        return retStr;
}

void
SInputAwareStringView::MessageReceived(BMessage *message)
{
        switch(message->what)
        {
                case B_INPUT_METHOD_EVENT: // 接收到输入法事件
                        {
                                int32 op_code; // 事件类型
                                if(message->FindInt32("be:opcode", &op_code) != B_OK) break;

                                switch(op_code)
                                {
                                        case B_INPUT_METHOD_STARTED: // 进行准备工作
                                                IMStarted(message);
                                                break;

                                        case B_INPUT_METHOD_STOPPED: // 结束输入
                                                IMStopped();
                                                break;

                                        case B_INPUT_METHOD_CHANGED: // 处理字符显示
                                                IMChanged(message);
                                                break;

                                        case B_INPUT_METHOD_LOCATION_REQUEST: // 处理光标位置查询
                                                IMLocationRequest(message);
                                                break;

                                        default: // 调用基类成员函数
                                                SStringView::MessageReceived(message);
                                }
                        }
                        break;

                default: // 调用基类成员函数
                        SStringView::MessageReceived(message);
        }
}


void
SInputAwareStringView::IMStarted(BMessage *message)
{
        // 存储我们要与之打交道的 BMessenger
        im_started = (message->FindMessenger("be:reply_to", &msgr_input) == B_OK);
}


void
SInputAwareStringView::IMStopped()
{
        msgr_input = BMessenger();
        SetText(NULL); // 清除文字
        im_started = false;
}


void
SInputAwareStringView::IMChanged(BMessage *message)
{
        if(!im_started) return;

        const char *im_string = NULL;
        message->FindString("be:string", &im_string);
        if(im_string == NULL) im_string = "";

        int32 start = 0, end = 0;

        BList color_list;

        for(int32 i = 0;
                message->FindInt32("be:clause_start", i, &start) == B_OK &&
                message->FindInt32("be:clause_end", i, &end) == B_OK; i++)
        {
                // 处理词语分隔
                if(end > start) // 合法
                {
                        // 将其置为蓝色背景, 偏移量按字节数计。
                        // 比如([]表示其起止):
                        // 字符串为: T h i s i s a [w o r d] .
                        // 字符偏移: 0 1 2 3 4 5 6 7  8 9 10 11
                        // "be:clause_start" = 7
                        // "be:clause_end" = 11
                        s_string_view_color *color = new s_string_view_color;
                        s_rgb_color_setto(&color->color, 0, 0, 0);
                        s_rgb_color_setto(&color->background, 152, 203, 255);
                        color->draw_background = true;
                        color->start_offset = start;
                        color->end_offset = end - 1;
                        color_list.AddItem((void*)color);
                }
        }

        for(int32 i = 0;
                message->FindInt32("be:selection", i * 2, &start) == B_OK &&
                message->FindInt32("be:selection", i * 2 + 1, &end) == B_OK; i++)
        {
                // 处理选择显示
                if(end > start) // 合法
                {
                        // 将其置为红色背景, 偏移量按字节数计。
                        // 比如([]表示其起止):
                        // 字符串为: T h i s i s a [w o r d] .
                        // 字符偏移: 0 1 2 3 4 5 6 7  8 9 10 11
                        // "be:selection"[0] = 7
                        // "be:selection"[1] = 11
                        s_string_view_color *color = new s_string_view_color;
                        s_rgb_color_setto(&color->color, 0, 0, 0);
                        s_rgb_color_setto(&color->background, 255, 152, 152);
                        color->draw_background = true;
                        color->start_offset = start;
                        color->end_offset = end - 1;
                        color_list.AddItem((void*)color);
                }
        }

        if(!color_list.IsEmpty()) // 不必太在乎下面的东西 :-)
        {
                int32 n = color_list.CountItems();
                s_string_view_color *colors = new s_string_view_color[n];

                for(int32 i = 0; i < n; i++)
                {
                        s_string_view_color *color = (s_string_view_color*)color_list.ItemAt(i);
                        if(color)
                        {
                                if(colors)
                                {
                                        s_rgb_color_setto(&colors[i].color, color->color);
                                        s_rgb_color_setto(&colors[i].background, color->background);
                                        colors[i].draw_background = color->draw_background;
                                        colors[i].start_offset = color->start_offset;
                                        colors[i].end_offset = color->end_offset;
                                }

                                delete color;
                        }
                }

                color_list.MakeEmpty();

                SetText(im_string, colors, n);
                if(colors) delete[] colors;
        }
        else
        {
                SetText(im_string);
        }
}


void
SInputAwareStringView::IMLocationRequest(BMessage *message)
{
        if(!im_started) return;

        const char *im_string = Text();
        if(im_string == NULL || *im_string == 0) return;

        BMessage reply(B_INPUT_METHOD_EVENT); // 要回复的消息
        reply.AddInt32("be:opcode", B_INPUT_METHOD_LOCATION_REQUEST); // 必须

        BPoint left_top = ConvertToScreen(BPoint(0, 0)); // 先取得当前视图坐标 (0, 0) 所对应屏幕的坐标

        int32 offset = 0;
        uint32 index = 0;

        while(true)
        {
                if(__utf8_char_at(im_string, index, &offset)) // 第 index + 1 个 UTF-8 字符
                {
                        BRect rect = TextRegion(offset, offset + 1).Frame(); // 取得字符显示区域
                        if(!rect.IsValid()) break;

                        // 变换为屏幕坐标
                        BPoint pt = left_top;
                        pt += rect.LeftTop();

                        reply.AddPoint("be:location_reply", pt); // 位置回复
                        reply.AddFloat("be:height_reply", rect.Height()); // 高度回复
                }
                else
                {
                        break;
                }

                index++;
        }

        // 发送给 Input Server
        msgr_input.SendMessage(&reply);
}

// 使用 extern "C" 是避免动态库因 C++ 的关系而添加过多的符号前缀
// _EXPORT 是在 PowerPC 平台的 Metrowerks C++ 而用
extern "C" _EXPORT {

BInputServerMethod* instantiate_input_method()
{
        // 创建输入法附件并传回给 Input Server
        return(new MyInputAddOn());
}

} // extern "C"

BInputServerMethod() // 可以在此中创建线程、初始设置等以便在 InitCheck() 成员函数中进行检查
~BInputServerMethod() // 解构函数，可在此中释放资源及等待线程结束等

virtual status_t MethodActivated(bool active)

status_t SetName(const char *name)

status_t SetIcon(const uchar *icon)

status_t SetMenu(const BMenu *menu, const BMessenger target)

// 这里的 message 不许使用 delete 进行释放，由 Input Server 自动处理。
status_t EnqueueMessage(BMessage *message)

// 继承于 BInputServerFilter 的成员函数
virtual status_t InitCheck();
status_t GetScreenRegion(BRegion *region) const;
virtual filter_result Filter(BMessage *message, BList *outList);

// 这里新创建的 BMessage 不许使用 delete 进行释放，由 Input Server 自动处理。
BMessage *new_message = new BMessage(message);
outList->AddItem(new_message);

class MyInputAddOnLooper : public BLooper {
        // 我们这里没有给出 class MyInputAddOnLooper 的实现
        // 请根据具体情况进行编写
        ...
};


class MyInputAddOn : public BInputServerMethod {
public:
        MyInputAddOn();
        virtual ~MyInputAddOn();

        virtual status_t InitCheck();
        virtual status_t MethodActivated(bool active);
        virtual filter_result Filter(BMessage *message, BList *outList);

private:
        friend class MyInputAddOnLooper;

        status_t fStatus;
        BMessenger fMsgrLooper;
};


MyInputAddOn::MyInputAddOn()
        : BInputServerMethod("My Input Method", NULL), fStatus(B_NO_INIT)
{
        // 创建一个 looper 用于响应事件
        // 在其中你可以进行必要的初始化
        MyInputAddOnLooper *myLooper = new MyInputAddOnLooper();

        // 检查是否妥当
        if(myLooper->CheckMyMethod() != B_OK)
        {
                myLooper->Lock();
                myLooper->Quit();
                return;
        }

        // 运行 looper
        myLooper->Run();

        // 设置信使，主要为多线程消息传递安全考虑
        fMsgrLooper = BMessenger(myLooper);
        if(fMsgrLooper.IsValid() == false)
        {
                if(myLooper->IsRunning())
                {
                        myLooper->PostMessage(B_QUIT_REQUESTED);
                }
                else
                {
                        myLooper->Lock();
                        myLooper->Quit();
                }
                return;
        }

        // 所有都没问题了...
        fStatus = B_OK;
}


MyInputAddOn::~MyInputAddOn()
{
        // 等待 looper 线程退出，你也可以使用 wait_for_thread 等
        while(fMsgrLooper.SendMessage(B_QUIT_REQUESTED) == B_OK) snooze(500000);
}


status_t
MyInputAddOn::InitCheck()
{
        return fStatus;
}


// MethodActivated:
// 这里较第一部分中处理 B_INPUT_METHOD_EVENT 不同的是
// 该事件由你的输入法附件向应用程序发出。
status_t
MyInputAddOn::MethodActivated(bool active)
{
        BMessage *msg;

        if(fMsgrLooper.IsValid() == false) return B_ERROR;

        if(active == false)
        {
                msg = new BMessage(B_INPUT_METHOD_EVENT);
                msg->AddInt32("be:opcode", B_INPUT_METHOD_STOPPED);
                EnqueueMessage(msg);

                // 告诉 looper: 用户要停止输入了
                fMsgrLooper.SendMessage(MY_MSG_METHOD_STOPPED);
                return B_OK;
        }

        msg = new BMessage(B_INPUT_METHOD_EVENT);
        msg->AddInt32("be:opcode", B_INPUT_METHOD_STARTED);
        msg->AddMessenger("be:reply_to", fMsgrLooper);
        EnqueueMessage(msg);

        // 告诉 looper: 用户要开始输入了
        fMsgrLooper.SendMessage(MY_MSG_METHOD_STARTED);

        return B_OK;
}


filter_result
MyInputAddOn::Filter(BMessage *message, BList *outList)
{
        // 如果不是键盘事件则继续处理事件，
        // 这里仅仅示例，你也可选择 B_MOUSE_DOWN 或其它的以支持手写等。
        // 更灵活的运用甚至可以接收语音输入... :-)
        if(message->what != B_KEY_DOWN) return B_DISPATCH_MESSAGE;

        // 如果这个消息由 looper 通过这里的 EnqueueMessage 发出则继续处理事件
        if(message->HasBool("MyInputAddOn:flags"))
        {
                message->RemoveBool("MyInputAddOn:flags");
                return B_DISPATCH_MESSAGE;
        }

        // 告诉 looper: 有新的事件需要处理了
        fMsgrLooper.SendMessage(message);

        return B_SKIP_MESSAGE;
}

结束语