2 * Copyright (c) 2007 Kov Chai <tchaikov@gmail.com>
3 * Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 * The contents of this file are subject to the terms of either the GNU Lesser
6 * General Public License Version 2.1 only ("LGPL") or the Common Development and
7 * Distribution License ("CDDL")(collectively, the "License"). You may not use this
8 * file except in compliance with the License. You can obtain a copy of the CDDL at
9 * http://www.opensource.org/licenses/cddl1.php and a copy of the LGPLv2.1 at
10 * http://www.opensource.org/licenses/lgpl-license.php. See the License for the
11 * specific language governing permissions and limitations under the License. When
12 * distributing the software, include this License Header Notice in each file and
13 * include the full text of the License in the License file as well as the
16 * NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE
18 * For Covered Software in this distribution, this License shall be governed by the
19 * laws of the State of California (excluding conflict-of-law provisions).
20 * Any litigation relating to this License shall be subject to the jurisdiction of
21 * the Federal Courts of the Northern District of California and the state courts
22 * of the State of California, with venue lying in Santa Clara County, California.
26 * If you wish your version of this file to be governed by only the CDDL or only
27 * the LGPL Version 2.1, indicate your decision by adding "[Contributor]" elects to
28 * include this software in this distribution under the [CDDL or LGPL Version 2.1]
29 * license." If you don't indicate a single choice of license, a recipient has the
30 * option to distribute your version of this file under either the CDDL or the LGPL
31 * Version 2.1, or to extend the choice of license to its licensees as provided
32 * above. However, if you add LGPL Version 2.1 code and therefore, elected the LGPL
33 * Version 2 license, then the option applies only if the new code is made subject
34 * to such option by the copyright holder.
36 * Modifications by Samsung Electronics Co., Ltd.
38 * 1.Added always candidate show feature
39 * 2.Added auto commit feature for mobile user
42 #define Uses_STL_AUTOPTR
43 #define Uses_STL_FUNCTIONAL
44 #define Uses_STL_VECTOR
45 #define Uses_STL_IOSTREAM
46 #define Uses_STL_FSTREAM
47 #define Uses_STL_ALGORITHM
49 #define Uses_STL_UTILITY
50 #define Uses_STL_IOMANIP
52 #define Uses_SCIM_UTILITY
53 #define Uses_SCIM_IMENGINE
54 #define Uses_SCIM_ICONV
55 #define Uses_SCIM_CONFIG_BASE
56 #define Uses_SCIM_CONFIG_PATH
57 #define Uses_SCIM_LOOKUP_TABLE
58 #define Uses_SCIM_DEBUG
60 #include <sys/types.h>
64 #include <imi_options.h>
66 #include <ic_history.h>
70 #include "imi_scimwin.h"
71 #include "sunpinyin_utils.h"
72 #include "sunpinyin_keycode.h"
73 #include "sunpinyin_lookup_table.h"
74 #include "sunpinyin_imengine.h"
75 #include "sunpinyin_imengine_config_keys.h"
76 #include "sunpinyin_private.h"
78 #define SCIM_PROP_STATUS "/IMEngine/SunPinyin/Status"
79 #define SCIM_PROP_LETTER "/IMEngine/SunPinyin/Letter"
80 #define SCIM_PROP_PUNCT "/IMEngine/SunPinyin/Punct"
82 #ifndef SCIM_SUNPINYIN_DATADIR
83 #define SCIM_SUNPINYIN_DATADIR "/usr/share/scim/sunpinyin"
87 #define SCIM_ICONDIR "/usr/share/scim/icons"
90 #ifndef SCIM_SUNPINYIN_ICON_FILE
91 #define SCIM_SUNPINYIN_ICON_FILE (SCIM_ICONDIR "/sunpinyin_logo.png")
94 #define SCIM_FULL_LETTER_ICON (SCIM_ICONDIR "/full-letter.png")
95 #define SCIM_HALF_LETTER_ICON (SCIM_ICONDIR "/half-letter.png")
96 #define SCIM_FULL_PUNCT_ICON (SCIM_ICONDIR "/full-punct.png")
97 #define SCIM_HALF_PUNCT_ICON (SCIM_ICONDIR "/half-punct.png")
101 static IMEngineFactoryPointer _scim_pinyin_factory (0);
103 static ConfigPointer _scim_config (0);
105 static Property _status_property (SCIM_PROP_STATUS, "");
106 static Property _letter_property (SCIM_PROP_LETTER, "");
107 static Property _punct_property (SCIM_PROP_PUNCT, "");
109 static char g_common_symbol[]={'#','$','%','^','&','*','@'};
112 void scim_module_init (void)
114 SCIM_DEBUG_IMENGINE (3) << "scim_module_init\n";
115 bindtextdomain (GETTEXT_PACKAGE, SCIM_SUNPINYIN_LOCALEDIR);
116 bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8");
119 void scim_module_exit (void)
121 _scim_pinyin_factory.reset ();
122 _scim_config.reset ();
125 uint32 scim_imengine_module_init (const ConfigPointer &config)
127 SCIM_DEBUG_IMENGINE (3) << "module_init\n";
128 _status_property.set_tip (_("The status of the current input method. Click to change it."));
129 _status_property.set_label ("英");
131 _letter_property.set_icon (SCIM_HALF_LETTER_ICON);
132 _letter_property.set_tip (_("The input mode of the letters. Click to toggle between half and full."));
133 _letter_property.set_label (_("Full/Half Letter"));
135 _punct_property.set_icon (SCIM_HALF_PUNCT_ICON);
136 _punct_property.set_tip (_("The input mode of the puncutations. Click to toggle between half and full."));
137 _punct_property.set_label (_("Full/Half Punct"));
139 _scim_config = config;
143 IMEngineFactoryPointer scim_imengine_module_create_factory (uint32 engine)
145 SCIM_DEBUG_IMENGINE (3) << "entering scim_imengine_module_create_factory()\n";
146 if (engine != 0) return IMEngineFactoryPointer (0);
147 if (_scim_pinyin_factory.null ()) {
148 SunPyFactory *factory = new SunPyFactory (_scim_config);
149 if (factory->valid ())
150 _scim_pinyin_factory = factory;
154 return _scim_pinyin_factory;
158 // implementation of SunPyFactory
159 SunPyFactory::SunPyFactory (const ConfigPointer &config)
163 SCIM_DEBUG_IMENGINE (3) << "SunPyFactory()\n";
164 set_languages ("zh_CN");
165 m_name = utf8_mbstowcs ("SunPinyin");
167 m_reload_signal_connection = m_config->signal_connect_reload (slot (this, &SunPyFactory::reload_config));
168 m_hotkey_profile = new CHotkeyProfile();
172 SunPyFactory::init ()
177 valid = load_user_config();
180 // postpone the load_user_data() to the ctor of SunPyInstance
185 SunPyFactory::load_user_config()
187 // Load configurations.
192 SunPyFactory::~SunPyFactory ()
194 SCIM_DEBUG_IMENGINE (3) << "~SunPyFactory()\n";
195 m_reload_signal_connection.disconnect ();
196 delete m_hotkey_profile;
200 SunPyFactory::get_name () const
206 SunPyFactory::get_authors () const
208 return utf8_mbstowcs (
209 String (_("Lei Zhang, <Phill.Zhang@sun.com>; Shuguagn Yan, <Ervin.Yan@sun.com>")));
213 SunPyFactory::get_credits () const
215 return utf8_mbstowcs (
216 String (_("Ported by Kov Chai, <tchaikov@gmail.com>")));
220 SunPyFactory::get_help () const
223 String (_("Hot Keys:"
225 " Switch between English/Chinese mode."
226 "\n\n Control+period:\n"
227 " Switch between full/half width punctuation mode."
228 "\n\n Shift+space:\n"
229 " Switch between full/half width letter mode."
231 " Page up in lookup table."
233 " Page down in lookup table."
235 " Cancel current syllable.\n"));
236 return utf8_mbstowcs (help);
240 SunPyFactory::get_uuid () const
242 return String ("3240fe82-585a-4f4a-96b3-0cad779c3b51");
246 SunPyFactory::get_icon_file () const
248 return String (SCIM_SUNPINYIN_ICON_FILE);
251 IMEngineInstancePointer
252 SunPyFactory::create_instance (const String& encoding, int id)
254 SCIM_DEBUG_IMENGINE (3) << "SunPyFactory::create_instance(" << id << ")\n";
255 return new SunPyInstance (this, m_hotkey_profile, encoding, id);
259 SunPyFactory::reload_config (const ConfigPointer &config)
265 // implementation of SunPyInstance
266 SunPyInstance::SunPyInstance (SunPyFactory *factory,
267 CHotkeyProfile *hotkey_profile,
268 const String& encoding,
270 : IMEngineInstanceBase (factory, encoding, id),
274 m_hotkey_profile (hotkey_profile),
276 m_common_lookup_table(0),
279 SCIM_DEBUG_IMENGINE (3) << get_id() << ": SunPyInstance()\n";
280 create_session(hotkey_profile);
282 m_reload_signal_connection = factory->m_config->signal_connect_reload (slot (this, &SunPyInstance::reload_config));
283 init_lookup_table_labels ();
286 SunPyInstance::~SunPyInstance ()
288 SCIM_DEBUG_IMENGINE (3) << get_id() << ": ~SunPyInstance()\n";
289 m_reload_signal_connection.disconnect ();
294 translate_key(const KeyEvent& key)
296 // XXX: may need to move this logic into CKeyEvent
297 if (!(key.code & 0xff00) && isprint(key.code) && !isspace(key.code) && !(key.mask & IM_CTRL_MASK)) {
298 // we only care about key_val here
299 return CKeyEvent(0, key.code, key.mask);
301 // what matters is key_code, but ibus sents me key_code as key_val
302 return CKeyEvent(key.code, 0, key.mask);
307 SunPyInstance::process_key_event (const KeyEvent& key)
309 SCIM_DEBUG_IMENGINE (3) << get_id() << ": process_key_event(" << m_focused << ", " <<
314 if (!m_focused) return false;
316 CKeyEvent ev = translate_key(key);
318 if ( !m_pv->getStatusAttrValue(CScimWinHandler::STATUS_ID_CN) ) {
319 // we are in English input mode
320 if ( !m_hotkey_profile->isModeSwitchKey(ev) ) {
321 m_hotkey_profile->rememberLastKey(ev);
325 return ( key.is_key_release() ||
326 m_pv->onKeyEvent(ev) );
330 SunPyInstance::select_candidate (unsigned int item)
332 if(m_lookup_table->number_of_candidates() == 0 && item < sizeof(g_common_symbol)/sizeof(char)) {
333 char _str[2]={g_common_symbol[item],0};
334 commit_string(utf8_mbstowcs(_str));
337 m_pv->onCandidateSelectRequest(item);
338 // m_pv->makeSelection(item);
342 SunPyInstance::update_lookup_table_page_size (unsigned int page_size)
345 SCIM_DEBUG_IMENGINE (3) << ": update_lookup_table_page_size(" << page_size << ")\n";
346 m_pv->setCandiWindowSize(page_size);
347 m_lookup_table->set_page_size(page_size);
352 SunPyInstance::lookup_table_page_up ()
355 m_pv->onCandidatePageRequest(-1, true);
359 SunPyInstance::lookup_page_up()
361 m_lookup_table->page_up();
362 // m_lookup_table->set_page_size(m_pv->s_CandiWindowSize);
366 SunPyInstance::lookup_page_down()
368 m_lookup_table->page_down();
369 // m_lookup_table->set_page_size(m_pv->s_CandiWindowSize);
373 SunPyInstance::lookup_table_page_down ()
375 // XXX, it would be great, if View class expose a page_up() method
376 // m_pv->onKeyEvent(IM_VK_PAGE_DOWN, 0, 0);
377 // classic View overrides this method
378 // but modern View uses the default dummy implementation
380 m_pv->onCandidatePageRequest(1, true);
384 SunPyInstance::move_preedit_caret (unsigned int /*pos*/)
389 SunPyInstance::reset ()
391 SCIM_DEBUG_IMENGINE (3) << get_id() << ": reset()\n";
393 m_lookup_table->clear ();
394 hide_preedit_string ();
395 //hide_aux_string ();
396 //m_pv->updateWindows(m_pv->clearIC());
397 //refresh_all_properties ();
398 show_lookup_table ();
399 m_pv->updateWindows(CIMIView::PREEDIT_MASK | CIMIView::CANDIDATE_MASK);
403 SunPyInstance::focus_in ()
405 SCIM_DEBUG_IMENGINE(3) << get_id() << ": focus_in ()\n";
407 show_lookup_table ();
408 initialize_all_properties ();
410 hide_preedit_string ();
411 //hide_aux_string ();
413 init_lookup_table_labels ();
415 //hide_aux_string ();
417 m_pv->updateWindows(CIMIView::PREEDIT_MASK | CIMIView::CANDIDATE_MASK);
421 SunPyInstance::focus_out ()
423 SCIM_DEBUG_IMENGINE(3) << get_id() << ": focus_out ()\n";
428 SunPyInstance::flush ()
430 SCIM_DEBUG_IMENGINE(3) << get_id() << ": flush ()\n";
431 m_pv->onCandidateSelectRequest(0);
435 SunPyInstance::trigger_property (const String &property)
437 SCIM_DEBUG_IMENGINE (3) << get_id() << ": trigger_property(" << property << ")\n";
439 if (property == SCIM_PROP_STATUS) {
440 const int is_CN = m_pv->getStatusAttrValue(CIMIWinHandler::STATUS_ID_CN);
441 m_pv->setStatusAttrValue(CIMIWinHandler::STATUS_ID_CN, is_CN?0:1);
442 } else if (property == SCIM_PROP_LETTER) {
443 const int is_fullsymbol = m_pv->getStatusAttrValue(CIMIWinHandler::STATUS_ID_FULLSYMBOL);
444 m_pv->setStatusAttrValue(CIMIWinHandler::STATUS_ID_FULLSYMBOL, is_fullsymbol?0:1);
445 } else if (property == SCIM_PROP_PUNCT) {
446 const int is_fullpunc = m_pv->getStatusAttrValue(CIMIWinHandler::STATUS_ID_FULLPUNC);
447 m_pv->setStatusAttrValue(CIMIWinHandler::STATUS_ID_FULLPUNC, is_fullpunc?0:1);
453 SunPyInstance::init_lookup_table_labels ()
455 m_pv->setCandiWindowSize(10);
456 m_lookup_table->set_page_size (10);
457 m_lookup_table->show_cursor ();
461 SunPyInstance::initialize_all_properties ()
463 PropertyList proplist;
465 proplist.push_back (_status_property);
466 proplist.push_back (_letter_property);
467 proplist.push_back (_punct_property);
469 register_properties (proplist);
470 refresh_all_properties ();
474 SunPyInstance::refresh_all_properties ()
476 SCIM_DEBUG_IMENGINE (3) << get_id() << ": refresh_all_properties()\n";
477 m_wh->updateStatus(CIMIWinHandler::STATUS_ID_CN,
478 m_pv->getStatusAttrValue(CIMIWinHandler::STATUS_ID_CN));
479 m_wh->updateStatus(CIMIWinHandler::STATUS_ID_FULLPUNC,
480 m_pv->getStatusAttrValue(CIMIWinHandler::STATUS_ID_FULLPUNC));
481 m_wh->updateStatus(CIMIWinHandler::STATUS_ID_FULLSYMBOL,
482 m_pv->getStatusAttrValue(CIMIWinHandler::STATUS_ID_FULLSYMBOL));
487 SunPyInstance::refresh_status_property(bool cn)
489 SCIM_DEBUG_IMENGINE (3) << get_id() << ": refresh_status_property(" << cn << ")\n";
493 _status_property.set_label(cn ? "中" : "英");
494 update_property(_status_property);
498 SunPyInstance::refresh_fullsymbol_property(bool full)
500 SCIM_DEBUG_IMENGINE (3) << get_id() << ": refresh_fullsimbol_property(" << full << ")\n";
501 _letter_property.set_icon(
502 full ? SCIM_FULL_LETTER_ICON : SCIM_HALF_LETTER_ICON);
503 update_property(_letter_property);
507 SunPyInstance::refresh_fullpunc_property(bool full)
509 _punct_property.set_icon(
510 full ? SCIM_FULL_PUNCT_ICON : SCIM_HALF_PUNCT_ICON);
511 update_property(_punct_property);
515 SunPyInstance::create_session(CHotkeyProfile *hotkey_profile)
517 SCIM_DEBUG_IMENGINE (3) << get_id() << ": create_session()\n";
519 CSunpinyinSessionFactory& factory = CSunpinyinSessionFactory::getFactory();
520 factory.setPinyinScheme(CSunpinyinSessionFactory::QUANPIN);
521 factory.setCandiWindowSize(10);
522 m_pv = factory.createSession();
524 SCIM_DEBUG_IMENGINE (3) << get_id() << " factory.createSession() failed\n";
528 m_pv->setHotkeyProfile(hotkey_profile);
530 m_lookup_table = new SunLookupTable();
531 m_common_lookup_table = new CommonLookupTable();
532 for(int i = 0;i < sizeof(g_common_symbol)/sizeof(char);i++) {
533 char _str[2]={g_common_symbol[i],0};
534 m_common_lookup_table->append_candidate (utf8_mbstowcs ((const char*)_str),attrs);
536 m_wh = new CScimWinHandler(this, m_lookup_table);
537 m_pv->attachWinHandler(m_wh);
541 SunPyInstance::destroy_session()
543 SCIM_DEBUG_IMENGINE (3) << get_id() << ": destroy_session()\n";
545 // wh and ic are not pointers, I don't think it's necessary to delete them
549 delete m_lookup_table;
550 delete m_common_lookup_table;
558 SunPyInstance::build_preedit_attribs (const IPreeditString* ppd)
561 const int sz = ppd->charTypeSize();
562 for (int i = 0; i < sz; ) {
563 const int ct = ppd->charTypeAt(i);
564 if (ct & IPreeditString::ILLEGAL) {
566 for (++i; (i<sz) && (ppd->charTypeAt(i) & IPreeditString::ILLEGAL); ++i) ;
567 attrs.push_back( Attribute(start, i-start,
568 SCIM_ATTR_DECORATE, SCIM_ATTR_DECORATE_REVERSE));
569 } else if (ct & IPreeditString::NORMAL_CHAR) {
570 if (ct & IPreeditString::USER_CHOICE) {
572 for (++i; (i<sz) && (ppd->charTypeAt(i) & IPreeditString::USER_CHOICE); ++i) ;
573 attrs.push_back( Attribute(start, i-start,
574 SCIM_ATTR_DECORATE, SCIM_ATTR_DECORATE_UNDERLINE));
586 SunPyInstance::redraw_preedit_string (const IPreeditString* ppd)
588 SCIM_DEBUG_IMENGINE (3) << get_id() << ": redraw_preedit_string()\n";
589 if (ppd->size() != 0) {
591 const int caret = ppd->caret();
592 if (caret > 0 && caret <= ppd->size()) {
593 attrs.push_back( Attribute(ppd->candi_start(),
595 SCIM_ATTR_DECORATE, SCIM_ATTR_DECORATE_REVERSE));
597 update_preedit_string( wstr_to_widestr(ppd->string(), ppd->size()) );
598 show_preedit_string ();
599 update_preedit_caret (caret);
601 hide_preedit_string ();
606 SunPyInstance::redraw_lookup_table(const ICandidateList* pcl)
608 SCIM_DEBUG_IMENGINE (3) << get_id() << ": redraw_lookup_table()\n";
610 m_lookup_table->update(*pcl);
611 if (m_lookup_table->number_of_candidates()) {
612 update_lookup_table(*m_lookup_table);
614 update_lookup_table(*m_common_lookup_table);
619 SunPyInstance::reload_config(const ConfigPointer &config)
621 SCIM_DEBUG_IMENGINE (3) << get_id() << ": reload_config()\n";
623 if (m_factory->valid()) {
624 m_factory->load_user_config();