1 /** @file isf_panel_agent_base.cpp
2 * @brief Implementation of class PanelAgentBase.
5 /* ISF is based on SCIM 1.4.7 and extended for supporting more mobile fitable. */
8 * Smart Common Input Method
10 * Copyright (c) 2005 James Su <suzhe@tsinghua.org.cn>
11 * Copyright (c) 2012-2016 Samsung Electronics Co., Ltd.
14 * This library is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Lesser General Public
16 * License as published by the Free Software Foundation; either
17 * version 2 of the License, or (at your option) any later version.
19 * This library is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Lesser General Public License for more details.
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this program; if not, write to the
26 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
27 * Boston, MA 02111-1307 USA
31 #define Uses_SCIM_TRANSACTION
32 #define Uses_SCIM_TRANS_COMMANDS
33 #define Uses_SCIM_PANEL_AGENT
34 #define Uses_SCIM_HELPER
35 #define Uses_SCIM_SOCKET
36 #define Uses_SCIM_EVENT
37 #define Uses_SCIM_CONFIG
38 #define Uses_SCIM_CONFIG_MODULE
39 #define Uses_SCIM_CONFIG_PATH
40 #define Uses_SCIM_UTILITY
43 #include <sys/types.h>
44 #include <sys/times.h>
47 #include "scim_private.h"
49 #include "scim_stl_map.h"
50 #include "isf_debug.h"
55 #define LOG_TAG "ISF_PANEL_AGENT_BASE"
62 PanelAgentBase::PanelAgentBase (const String& name)
68 PanelAgentBase::~PanelAgentBase ()
72 bool PanelAgentBase::initialize (InfoManager* info_manager, const String& display, bool resident)
77 bool PanelAgentBase::valid (void) const
82 void PanelAgentBase::stop (void)
86 void PanelAgentBase::update_panel_event (int client, uint32 context, int cmd, uint32 nType, uint32 nValue)
90 void PanelAgentBase::reset_keyboard_ise (int client, uint32 context)
94 void PanelAgentBase::update_keyboard_ise_list (int client, uint32 context)
98 void PanelAgentBase::change_factory (int client, uint32 context, const String& uuid)
102 void PanelAgentBase::helper_candidate_show (int client, uint32 context, const String& uuid)
106 void PanelAgentBase::helper_candidate_hide (int client, uint32 context, const String& uuid)
110 /* if the uuid is empty, it must send to panelclient otherwise HelperAgent
112 void PanelAgentBase::candidate_more_window_show (int client, uint32 context)
115 /* if the uuid is empty, it must send to panelclient otherwise HelperAgent
117 void PanelAgentBase::candidate_more_window_hide (int client, uint32 context)
121 void PanelAgentBase::update_helper_lookup_table (int client, uint32 context, const String& uuid, const LookupTable& table)
127 //SCIM_TRANS_CMD_SELECT_AUX
128 //this function called by two places, will send message to help(with uuid) or app
129 void PanelAgentBase::select_aux (int client, uint32 context, uint32 item)
132 //SCIM_TRANS_CMD_SELECT_CANDIDATE
133 //this function called by two places, will send message to help(with uuid) or app
134 void PanelAgentBase::select_candidate (int client, uint32 context, uint32 item)
138 void PanelAgentBase::lookup_table_page_up (int client, uint32 context)
142 void PanelAgentBase::lookup_table_page_down (int client, uint32 context)
146 void PanelAgentBase::update_lookup_table_page_size (int client, uint32 context, uint32 size)
150 void PanelAgentBase::update_candidate_item_layout (int client, uint32 context, const std::vector<uint32>& row_items)
154 void PanelAgentBase::select_associate (int client, uint32 context, uint32 item)
158 void PanelAgentBase::associate_table_page_up (int client, uint32 context)
162 void PanelAgentBase::associate_table_page_down (int client, uint32 context)
166 void PanelAgentBase::update_associate_table_page_size (int client, uint32 context, uint32 size)
170 void PanelAgentBase::update_displayed_candidate_number (int client, uint32 context, uint32 size)
174 void PanelAgentBase::send_longpress_event (int client, uint32 context, uint32 index)
178 void PanelAgentBase::trigger_property (int client, uint32 context, const String& property)
182 void PanelAgentBase::socket_start_helper (int client, uint32 context, const String& ic_uuid)
186 void PanelAgentBase::exit (int client, uint32 context)
190 void PanelAgentBase::focus_out_helper (int client, uint32 context, const String& uuid)
194 void PanelAgentBase::focus_in_helper (int client, uint32 context, const String& uuid)
198 void PanelAgentBase::show_helper (int client, uint32 context, const String& uuid, char* data, size_t& len)
202 void PanelAgentBase::hide_helper (int client, uint32 context, const String& uuid)
206 void PanelAgentBase::set_helper_mode (int client, uint32 context, const String& uuid, uint32& mode)
210 void PanelAgentBase::set_helper_language (int client, uint32 context, const String& uuid, uint32& language)
214 void PanelAgentBase::set_helper_imdata (int client, uint32 context, const String& uuid, const char* imdata, size_t& len)
218 void PanelAgentBase::set_helper_return_key_type (int client, uint32 context, const String& uuid, uint32 type)
222 void PanelAgentBase::get_helper_return_key_type (int client, uint32 context, const String& uuid, _OUT_ uint32& type)
226 void PanelAgentBase::set_helper_return_key_disable (int client, uint32 context, const String& uuid, uint32 disabled)
230 void PanelAgentBase::get_helper_return_key_disable (int client, uint32 context, const String& uuid, _OUT_ uint32& disabled)
234 void PanelAgentBase::set_helper_layout (int client, uint32 context, const String& uuid, uint32& layout)
238 void PanelAgentBase::set_helper_input_mode (int client, uint32 context, const String& uuid, uint32& mode)
242 void PanelAgentBase::set_helper_input_hint (int client, uint32 context, const String& uuid, uint32& hint)
246 void PanelAgentBase::set_helper_bidi_direction (int client, uint32 context, const String& uuid, uint32& direction)
250 void PanelAgentBase::set_helper_caps_mode (int client, uint32 context, const String& uuid, uint32& mode)
254 void PanelAgentBase::show_helper_option_window (int client, uint32 context, const String& uuid)
258 void PanelAgentBase::resume_helper_option_window (int client, uint32 context, const String& uuid)
262 void PanelAgentBase::set_helper_keyboard_mode (int client, uint32 context, const String& uuid, uint32& mode)
266 void PanelAgentBase::set_helper_prediction_hint (int client, uint32 context, const String& uuid, String& prediction_hint)
270 void PanelAgentBase::set_helper_mime_type (int client, uint32 context, const String& uuid, String& mime_type)
274 void PanelAgentBase::finalize_content_helper (int client, uint32 context, const String& uuid, String& text, uint32& cursor_pos)
278 void PanelAgentBase::set_helper_prediction_hint_data (int client, uint32 context, const String& uuid, String& key, String& value)
282 bool PanelAgentBase::process_key_event (int client, uint32 context, const String& uuid, KeyEvent& key, uint32 serial)
287 bool PanelAgentBase::get_helper_geometry (int client, uint32 context, String& uuid, _OUT_ struct rectinfo& info)
292 void PanelAgentBase::get_helper_imdata (int client, uint32 context, String& uuid, _OUT_ char** imdata, _OUT_ size_t& len)
296 void PanelAgentBase::get_helper_layout (int client, uint32 context, String& uuid, uint32& layout)
300 void PanelAgentBase::get_ise_language_locale (int client, uint32 context, String& uuid, _OUT_ char** data, _OUT_ size_t& len)
304 void PanelAgentBase::check_option_window (int client, uint32 context, String& uuid, _OUT_ uint32& avail)
308 void PanelAgentBase::reset_ise_option (int client, uint32 context)
312 void PanelAgentBase::reset_helper_context (int client, uint32 context, const String& uuid)
316 void PanelAgentBase::reload_config (int client)
320 void PanelAgentBase::socket_update_surrounding_text (int client, uint32 context, const String& uuid, String& text, uint32 cursor)
324 void PanelAgentBase::socket_remoteinput_focus_in (int client)
328 void PanelAgentBase::socket_remoteinput_focus_out (int client)
332 void PanelAgentBase::socket_remoteinput_entry_metadata (int client, uint32 hint, uint32 layout, int variation, uint32 autocapital_type, int return_key_disabled)
336 void PanelAgentBase::socket_remoteinput_surrounding_text (int client, String& text, uint32 cursor)
340 void PanelAgentBase::socket_remoteinput_input_resource (int client, uint32 input_resource)
344 void PanelAgentBase::socket_update_selection (int client, uint32 context, String& uuid, String text)
348 void PanelAgentBase::socket_get_keyboard_ise_list (int client, uint32 context, const String& uuid, std::vector<String>& list)
352 void PanelAgentBase::socket_get_candidate_ui (int client, uint32 context, const String& uuid, int style, int mode)
356 void PanelAgentBase::socket_get_candidate_geometry (int client, uint32 context, const String& uuid, struct rectinfo& info)
360 void PanelAgentBase::socket_get_keyboard_ise (int client, uint32 context, const String& uuid, String& ise_name, String& ise_uuid)
364 void PanelAgentBase::helper_detach_input_context (int client, uint32 context, const String& ic_uuid)
368 void PanelAgentBase::helper_process_imengine_event (int client, uint32 context, const String& ic_uuid, const Transaction& nest_transaction)
372 void PanelAgentBase::process_helper_event (int client, uint32 context, String target_uuid, String active_uuid, Transaction& nest_trans)
376 void PanelAgentBase::socket_helper_key_event (int client, uint32 context, int cmd , KeyEvent& key)
380 //SCIM_TRANS_CMD_GET_SURROUNDING_TEXT
381 //socket_helper_get_surrounding_text
382 void PanelAgentBase::socket_helper_get_surrounding_text (int client, uint32 context, uint32 maxlen_before, uint32 maxlen_after)
385 //SCIM_TRANS_CMD_DELETE_SURROUNDING_TEXT
386 //socket_helper_delete_surrounding_text
387 void PanelAgentBase::socket_helper_delete_surrounding_text (int client, uint32 context, uint32 offset, uint32 len)
390 //SCIM_TRANS_CMD_GET_SELECTION
391 void PanelAgentBase::socket_helper_get_selection (int client, uint32 context)
394 //SCIM_TRANS_CMD_SET_SELECTION
395 void PanelAgentBase::socket_helper_set_selection (int client, uint32 context, uint32 start, uint32 end)
399 //socket_helper_update_input_context
400 //ISM_TRANS_CMD_UPDATE_ISE_INPUT_CONTEXT
401 void PanelAgentBase::update_ise_input_context (int client, uint32 context, uint32 type, uint32 value)
405 //socket_helper_update_language_locale
406 //ISM_TRANS_CMD_UPDATE_ISE_LANGUAGE_LOCALE
407 void PanelAgentBase::update_ise_language_locale(int client, uint32 context, String locale)
411 //socket_helper_send_private_command
412 //SCIM_TRANS_CMD_SEND_PRIVATE_COMMAND
413 void PanelAgentBase::send_private_command (int client, uint32 context, const String& command)
417 //socket_helper_commit_content
418 //SCIM_TRANS_CMD_COMMIT_CONTENT
419 void PanelAgentBase::commit_content (int client, uint32 context, const String& content, const String& description, const String& mime_types)
423 //SCIM_TRANS_CMD_UPDATE_SPOT_LOCATION
424 void PanelAgentBase::helper_all_update_spot_location (int client, uint32 context, String uuid, int x, int y)
427 //ISM_TRANS_CMD_UPDATE_CURSOR_POSITION
428 void PanelAgentBase::helper_all_update_cursor_position (int client, uint32 context, String uuid, int cursor_pos)
431 //SCIM_TRANS_CMD_UPDATE_SCREEN
432 void PanelAgentBase::helper_all_update_screen (int client, uint32 context, String uuid, int screen)
436 //socket_helper_commit_string
437 //SCIM_TRANS_CMD_COMMIT_STRING
438 void PanelAgentBase::commit_string (int client, uint32 context, const WideString& wstr)
441 //socket_helper_show_preedit_string
442 //SCIM_TRANS_CMD_SHOW_PREEDIT_STRING
443 void PanelAgentBase::show_preedit_string (int client, uint32 context)
446 //socket_helper_hide_preedit_string
447 //SCIM_TRANS_CMD_HIDE_PREEDIT_STRING
448 void PanelAgentBase::hide_preedit_string (int client, uint32 context)
451 //socket_helper_update_preedit_string
452 //SCIM_TRANS_CMD_UPDATE_PREEDIT_STRING
453 void PanelAgentBase::update_preedit_string (int client, uint32 context, WideString preedit, WideString commit, AttributeList& attrs, uint32 caret)
456 //socket_helper_update_preedit_caret
457 //SCIM_TRANS_CMD_UPDATE_PREEDIT_CARET
458 void PanelAgentBase::update_preedit_caret (int client, uint32 context, uint32 caret)
461 //socket_helper_recapture_string
462 //ISM_TRANS_CMD_RECAPTURE_STRING
463 void PanelAgentBase::recapture_string (int client, uint32 context, int offset, int len, WideString preedit, WideString commit, AttributeList& attrs)
466 //socket_helper_register_helper
467 //SCIM_TRANS_CMD_HELPER_ATTACH_INPUT_CONTEXT
468 //SCIM_TRANS_CMD_UPDATE_SCREEN
469 void PanelAgentBase::helper_attach_input_context_and_update_screen (int client, std::vector < std::pair <uint32, String> >& helper_ic_index,
470 uint32 current_screen)
474 void PanelAgentBase::hide_helper_ise (int client, uint32 context)
478 bool PanelAgentBase::process_input_device_event(int client, uint32 context, const String& uuid, uint32 type, const char *data, size_t len, _OUT_ uint32& result)
483 void PanelAgentBase::process_key_event_done(int client, uint32 context, KeyEvent &key, uint32 ret, uint32 serial)
487 void PanelAgentBase::request_ise_hide(int client, uint32 context)
491 void PanelAgentBase::set_autocapital_type(int client, uint32 context, String uuid, int mode)
495 void PanelAgentBase::update_ise_geometry (int client, uint32 context, uint32 x, uint32 y, uint32 width, uint32 height)
499 void PanelAgentBase::remote_update_preedit_string (int client, uint32 context, const WideString str, const WideString commit, const AttributeList &attrs, uint32 caret)
503 void PanelAgentBase::remote_send_key_event (int client, uint32 context, const KeyEvent &key)
507 void PanelAgentBase::remote_forward_key_event (int client, uint32 context, const KeyEvent &key)
511 void PanelAgentBase::remote_commit_string (int client, uint32 context, const WideString& wstr)
515 void PanelAgentBase::remote_delete_surrounding_text (int client, uint32 context, uint32 offset, uint32 len)
519 void PanelAgentBase::set_prediction_allow (int client, uint32 context, String uuid, int mode)
523 void PanelAgentBase::send_fail_reply (int client)
527 void PanelAgentBase::update_entry_metadata (int client, uint32 context)
530 } /* namespace scim */
533 vi:ts=4:nowrap:ai:expandtab