kmx_sdk.c 40.8 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200

#include "MMI_features.h"

#ifdef __MMI_IME_PLUG_IN__
#include "kmx_input_config.h"

#include "kmx_input_prot.h"

#ifdef __MMI_KMX_TOUCH_INPUT__
#include "kmxsip_input_method.h"
#endif 

#include "kmximmapi.h"
#include "cstar_ime.h"

#include "kmx_sdk_translate.h"

#include "GlobalResDef.h"
#include "wgui_categories_util.h"

#include "kmx_gui.h"

#include "Mmi_frm_input_gprot.h"

static U32 mmi_ime_sdk_send_imc_message(mmi_imc_editor_message_id_enum msg_id, U32 param0, U32 param1)
{
    mmi_imc_message_struct msg;
        
    msg.message_id = msg_id;
    msg.param_0 = param0;
    msg.param_1 = param1;

    return mmi_ime_sdk_send_editor_msg(&msg);
}

#ifdef __MMI_QWERTY_KEYPAD_SUPPORT__
int kmx_update_special_key_status(mmi_ime_sdk_key_event_data_struct_p key_data, mmi_ime_sdk_special_key_status_struct_p special_key_status);
static int kmx_on_special_key_status_changed(U32 special_key_flag, U32 special_key_lock_flag);
static int kmx_on_special_key_status_reset(void);
#endif 
static void kmx_on_cursor_moved(void);
void kmx_ime_sdk_set_softkey_by_state(mmi_ime_sdk_state_enum state);
void kmx_ime_sdk_redraw_softkey_by_state(mmi_ime_sdk_state_enum state);
#if defined(__MMI_TOUCH_SCREEN__)
U32 kmx_ime_sdk_imui_control_translate_pen_event(mmi_ime_sdk_imui_control_enum control, 
                                                 mmi_ime_sdk_pen_event_data_struct_p pen_event_data);
#endif

U32 kmx_ime_sdk_get_ui_set_by_state(mmi_ime_sdk_state_enum state);
void kmx_ime_sdk_update_controls(U32 imui_set);

void kmx_ime_add_ui_all_controls(void);

int kmx_ime_is_ime_support(void);

static int g_kmx_is_ime_supported;

static U32 kmx_check_input_mode_avaliable(mmi_imm_input_mode_enum input_mode);

#ifdef __MMI_IME_AUTO_CAPITALIZATION__
static MMI_BOOL g_kmx_skip_cursor_movement_event = MMI_FALSE;
#endif

#ifdef __MMI_KMX_TOUCH_INPUT__
/* Return 0 if state is intital state or non-vk state, otherwise return 1 */
int kmx_ime_is_vk_input_state(mmi_ime_sdk_state_enum state);
#endif

int kmx_ime_is_key_input_state(mmi_ime_sdk_state_enum state);

U32 mmi_ime_sdk_vendor_handle_message(mmi_ime_sdk_msg_id_enum message_id, U32 param0, U32 param1)
{
    U32 ret = MMI_TRUE;
        
    switch(message_id) {
    case MMI_IME_SDK_MSG_EDITOR_CONNECTED:
        {            
		    kmx_ime_setup_input_method();
            #ifdef __MMI_KMX_TOUCH_INPUT__
            kmx_input_method_select();
            #endif
            kmx_ime_config_feature_options();
            #ifdef __MMI_IME_AUTO_CAPITALIZATION__
            g_kmx_skip_cursor_movement_event = MMI_TRUE;
            #endif
        }
    	break;
    case MMI_IME_SDK_MSG_EDITOR_DISCONNECTING:
        {            
            #ifdef __MMI_KMX_TOUCH_INPUT__
            kmx_input_method_deselect();
            #endif
            kmx_ime_close_input_method();    
            #ifdef __MMI_QWERTY_KEYPAD_SUPPORT__
            kmx_on_special_key_status_reset();
            #endif
            
            kmx_gui_exit();
        }
        break;
    case MMI_IME_SDK_MSG_EDITOR_DISCONNECTED:
    {
        break;
    }        
    case MMI_IME_SDK_MSG_STATE_CHANGED:        
        {
            mmi_ime_sdk_state_enum pre_state, cur_state;            
            pre_state = (mmi_ime_sdk_state_enum)param0;
			cur_state = (mmi_ime_sdk_state_enum)param1;
            if (pre_state != cur_state && cur_state == MMI_IME_SDK_STATE_INITIAL)
            {				                
                cstar_ime_reset_state();
            }
        }
		break;
	case MMI_IME_SDK_MSG_RESET:
		{		    
            cstar_ime_reset_state();
			break;
		}
    case MMI_IME_SDK_MSG_CHANGE_INPUT_MODE:
        {
            g_kmx_is_ime_supported = 0;
            g_kmx_is_ime_supported |= kmx_ime_set_input_mode((int)param0);
            #ifdef __MMI_KMX_TOUCH_INPUT__
	        g_kmx_is_ime_supported |= kmx_input_method_change_input_mode((int)param0);
            #endif            
        }
        break;
    case MMI_IME_SDK_MSG_KEY_EVENT:
        if(cstar_ime_is_ime_support())
        {            
            U16 key_code, key_type;
			UI_character_type ucs2_code = 0;
			U32 special_key_flag = 0;
            int handled = 0;

			mmi_ime_sdk_key_event_data_struct_p key_event_data;
			mmi_ime_sdk_key_event_special_data_struct_p key_special_data;

			key_event_data = (mmi_ime_sdk_key_event_data_struct_p) param0;
			key_special_data = (mmi_ime_sdk_key_event_special_data_struct_p) param1;

			key_code = key_event_data->mmi_key_code;
			key_type = key_event_data->mmi_key_type;
            
            /* Filter event type */
            if (key_type != KEY_EVENT_DOWN && key_type != KEY_EVENT_UP && key_type != KEY_LONG_PRESS)
            {
                /* just eat other type event */
                break;
            }

			if(key_special_data)
			{
				ucs2_code = key_special_data->ucs2_code;
				special_key_flag = key_special_data->special_key_flag;
			}
            
        #ifdef __MMI_KMX_TOUCH_INPUT__            
            if(!kmx_input_method_handle_key_event(key_code, key_type))
        #endif
                if(!cstar_ime_handle_key(key_code, key_type, (int)ucs2_code))
                {                    
                    handled = kmx_default_handle_key(key_code, key_type, ucs2_code);
                    #ifdef __MMI_KMX_TOUCH_INPUT__
                    if (!handled)
                    {
                        if (kmx_input_method_is_keypad_enable()
                                && kmx_ime_is_vk_input_state(mmi_ime_sdk_get_state())
                                && (key_code == KEY_LSK && key_type == KEY_EVENT_UP)
                                )
                        {
                            mmi_ime_sdk_set_state(MMI_IME_SDK_STATE_INITIAL);
                            mmi_ime_sdk_redraw_screen_by_state();
                        }
                    }
                    #endif
                    if (!handled && key_code == KEY_END)
                        ret = MMI_FALSE;
                }
        }
        else
        {
            ret = MMI_FALSE;
        }
        break;
    #ifdef __MMI_VIRTUAL_KEYBOARD__
    case MMI_IME_SDK_MSG_VK_EVENT:        
        {
			mmi_pen_event_type_enum pen_event_type;
			mmi_ime_sdk_vk_event_data_struct_p vk_event_data;
			
			pen_event_type = (mmi_pen_event_type_enum) param0;
			vk_event_data  = (mmi_ime_sdk_vk_event_data_struct_p) param1;

            #if defined(__MMI_KMX_TOUCH_INPUT__) && !defined(__NO_HANDWRITING__)
            if (vk_event_data && vk_event_data->vk_event == GUI_VKBD_PEN_HANDWRITING && pen_event_type == MMI_PEN_EVENT_UP)
            {
                if (kmx_input_method_exit_handwriting_panel())
                    mmi_ime_sdk_redraw_screen_by_state();
                break;
            }
            #endif

            if(!cstar_ime_is_ime_support() || !vk_event_data)
            {
                ret = MMI_FALSE;
                break;
            }

            #ifdef __MMI_KMX_HALF_QWERTY_BOPOMOFO__
            {                
                if (kmx_ime_handle_bopomofo_half_qwerty_char(pen_event_type, vk_event_data->character, vk_event_data->vk_event))
                    break;
            }
            #endif

            if (pen_event_type != MMI_PEN_EVENT_UP)
            {
                ret = MMI_FALSE;
                break;
            }

            switch(vk_event_data->vk_event)
            {
                case GUI_VKBD_PEN_BAKSPACE:
                #ifdef __MMI_IME_FTE_ENHANCE__
                case GUI_VKBD_PEN_ALPHANUMERIC_KEY_DELETE:
                #endif
                    {             
                        ret = cstar_ime_handle_key(KEY_RSK, KEY_EVENT_UP, 0);
                    }
                    break;
                case GUI_VKBD_PEN_CHAR_I:
                    {                        
                        if(!cstar_ime_handle_event(1, (int)vk_event_data->character, 0))
                        {
                            mmi_ime_sdk_send_imc_message(MMI_IMC_MESSAGE_INSERT_CHAR, vk_event_data->character, 0);
                        }		            		                
                    }
                    break;
                #ifdef __MMI_IME_FTE_ENHANCE__
                case GUI_VKBD_PEN_STROKE_1:
                    {
                        kmx_ime_handle_stroke_char(0xF004);
                    }
                    break;
                case GUI_VKBD_PEN_STROKE_2:
                    {                     
                        kmx_ime_handle_stroke_char(0xF001);
                    }
                    break;
                case GUI_VKBD_PEN_STROKE_3:
                    {                     
                        kmx_ime_handle_stroke_char(0xF007);
                    }
                    break;
                case GUI_VKBD_PEN_STROKE_4:
                    {                     
                        kmx_ime_handle_stroke_char(0xF002);
                    }
                    break;
                case GUI_VKBD_PEN_STROKE_5:
                    {                     
                        kmx_ime_handle_stroke_char(0xF005);
                    }
                    break;
                case GUI_VKBD_PEN_STROKE_DEPART:
                    {                     
                        kmx_ime_handle_stroke_char(0xF000);
                    }
                    break;
                #endif
                    default:
                    ret = MMI_FALSE;
                    break;
            }
        }
        break;
    #if defined(__MMI_UI_VIRTUAL_KEYBOARD_DEFAULT_VERSION_2__)
    case MMI_IME_SDK_MSG_VK_CALLBACK_EVENT:
        {
            #ifdef __MMI_KMX_HALF_QWERTY_BOPOMOFO__
            mmi_ime_sdk_vk_event_callback_data_struct_p vk_callback_data;
            vk_callback_data = (mmi_ime_sdk_vk_event_callback_data_struct_p)param0;
            ret = MMI_FALSE;            
            if(vk_callback_data)
            {                
                ret = kmx_ime_handle_vk_event_callback(vk_callback_data->vk_event,
                                                       vk_callback_data->key_param,
                                                       (int)vk_callback_data->ret_ptr,
                                                       (int)vk_callback_data->ret_val_ptr);
            }
            #else
            ret = MMI_FALSE;            
            #endif
        }
        break;
    #endif
    #endif
    case MMI_IME_SDK_MSG_CLEAR_LAST_FIXED_UI_CONTROLS:
        {            
            CS_UI_RECT ime_wnd;
            if (param0 & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW))
            {
                kmx_get_ime_window_difference(&ime_wnd);
                if( (ime_wnd.left != ime_wnd.right) && (ime_wnd.top != ime_wnd.bottom))
                    mmi_ime_sdk_redraw_imui_background(ime_wnd.left, ime_wnd.top, ime_wnd.right - 1, ime_wnd.bottom);
            }
            #if defined(__MMI_VIRTUAL_KEYBOARD__)
            if (param0 & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD))
            {
                #ifdef __MMI_KMX_TOUCH_INPUT__
                kmxsip_input_method_clear_keypad_area();
                #endif
            }
            #endif
        }
        break;
    case MMI_IME_SDK_MSG_DRAW_CURRENT_FIXED_UI_CONTROLS:
        {
            int bottom_y;
            bottom_y = param1;
            
            #if defined(__MMI_VIRTUAL_KEYBOARD__)
            if (param0 & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD))
            {
                #ifdef __MMI_KMX_TOUCH_INPUT__
                kmx_input_method_update_view(bottom_y);            
                kmx_input_method_get_keypad_pos(0, &bottom_y);
                bottom_y -= 1;
                #endif
            }
            #endif

            if (param0 & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW))
            {                                
                bottom_y = (U32)kmx_ime_paint_ime_window(0, bottom_y);
            }
            
            ret = bottom_y;
        }
        break;
    case MMI_IME_SDK_MSG_GET_CURRENT_FIXED_CONTROL_SET:
        {
            PU32 imui_set_ptr = (PU32) param0;

            if(!kmx_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }

            if (imui_set_ptr)
            {
                *imui_set_ptr = kmx_ime_sdk_get_ui_set_by_state(mmi_ime_sdk_get_state());
            }
        }
        break;
    case MMI_IME_SDK_MSG_CONFIG_UI_CONTROLS_BY_IME_STATE:
        {
            U32 imui_set;
            
            if(!kmx_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }
            
            #if defined(__MMI_IME_FTE_ENHANCE__) && !defined(__NO_HANDWRITING__)
            /* Return False if current input pattern is handwriting */
            if (mmi_imm_get_keyboard_type() == IMM_KEYPAD_HANDWRITING)
            {
                ret = MMI_FALSE;
                break;
            }                        
            #endif /* #if defined(__MMI_IME_FTE_ENHANCE__) && !defined(__NO_HANDWRITING__) */

            #if defined(__MMI_KMX_TOUCH_INPUT__) && defined(__MMI_IME_FTE_ENHANCE__)
            /* if VK is set to off, change input state to initial state */
            if (kmx_input_method_is_keypad_enable()
                && kmx_ime_is_vk_input_state(mmi_ime_sdk_get_state())
                && (mmi_imc_get_ui_style(MMI_IMC_UI_STYLE_VK_ON) == MMI_FALSE))
            {
                mmi_ime_sdk_set_state(MMI_IME_SDK_STATE_INITIAL);
            }
            #endif
            imui_set = kmx_ime_sdk_get_ui_set_by_state(mmi_ime_sdk_get_state());
            kmx_ime_sdk_update_controls(imui_set);                            
        }
        break;
    case MMI_IME_SDK_MSG_GET_UI_CONTROL_HEIGHT:
        {
            ret = 0;
            if (param0 & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW))
            {                
                ret += kmx_get_ime_window_height();
            }
            #if defined(__MMI_VIRTUAL_KEYBOARD__)
			#ifdef __MMI_KMX_TOUCH_INPUT__
            if (param0 & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD))
            {                
                int w, h;
                kmx_input_method_get_keypad_size(&w, &h);
                ret += h;
            }
			#endif
            #endif
        }
        break;
    #ifdef __MMI_QWERTY_KEYPAD_SUPPORT__
    case MMI_IME_SDK_MSG_UPDATE_SPECIAL_KEY_STATUS:
        {
            mmi_ime_sdk_key_event_data_struct_p key_data;
			mmi_ime_sdk_special_key_status_struct_p	special_key_status;
			
            if(!mmi_imc_is_connected() || !cstar_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }

            key_data           = (mmi_ime_sdk_key_event_data_struct_p)param0;
            special_key_status = (mmi_ime_sdk_special_key_status_struct_p)param1;            
            
            if (special_key_status && key_data)
            {
                memset(special_key_status, 0, sizeof(*special_key_status));
                if(!kmx_update_special_key_status(key_data, special_key_status))                
                    ret = MMI_FALSE;                
            }
        }
        break;
    case MMI_IME_SDK_MSG_SPECIAL_KEY_STATUS_CHANGED:
		{
			mmi_ime_sdk_special_key_status_struct_p special_key_status;
			special_key_status = (mmi_ime_sdk_special_key_status_struct_p)param0;
			kmx_on_special_key_status_changed(special_key_status->special_key_flag, special_key_status->special_key_lock_flags);
		}
        break;
    case MMI_IME_SDK_MSG_GET_INVALID_QWERTY_SPECIAL_KEY:
        {
            U32 invalid_flag;
            const KMX_INPUT_MODE_ATTRIBUTES* mode_attr;
            invalid_flag = (U32) param0;

            mode_attr = kmx_get_curr_input_mode_attr();
            ret = invalid_flag;

            /* TODO: May be we should cancel shift status for no smart case-sensitive input */
            if (mode_attr && (mode_attr->ime == KMX_IME_STROKE || mode_attr->ime == KMX_IME_PINYIN || mode_attr->ime == KMX_IME_BOPOMOFO))
            {
                /* enable FN for these input mode */
                ret = invalid_flag & ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;
            }            
        }
        break;
    #endif
    case MMI_IME_SDK_MSG_EDITOR_CURSOR_MOVED:
        {
            mmi_ime_sdk_state_enum state;
            state = mmi_ime_sdk_get_state();
            
            #ifdef __MMI_IME_AUTO_CAPITALIZATION__
            if (g_kmx_skip_cursor_movement_event)
            {
                g_kmx_skip_cursor_movement_event = MMI_FALSE;
                ret = MMI_FALSE;
                break;
            }
            #endif
            
            #ifdef __MMI_KMX_TOUCH_INPUT__
            if (state == MMI_IME_SDK_STATE_INITIAL || kmx_ime_is_vk_input_state(state))
            {
                if (kmx_input_method_on_editor_cursor_moved())
                {
                    ret = MMI_TRUE;
                    break;
                }
            }
            #endif
            
            /* TODO: key engine handle this message? */
            
            if (state == MMI_IME_SDK_STATE_MTK ||
                state == MMI_IME_SDK_STATE_INITIAL ||
                state == MMI_IMC_STATE_NONE
            )
            {
                /* Let platform handle this situation. */
                ret = MMI_FALSE;
            }
            else
            {
                ret = MMI_TRUE;
            }        
        }
        break;
	case MMI_IME_SDK_MSG_REDRAW_UI_CONTROLS:
		// TODO:
		break;
	case MMI_IME_SDK_MSG_ADD_ALL_CONTROLS:
		{
			kmx_ime_add_ui_all_controls();
		}
		break;
    case MMI_IME_SDK_MSG_SET_SOFTKEY_BY_STATE:
        {
            mmi_ime_sdk_state_enum state = (mmi_ime_sdk_state_enum) param0;
            if(!kmx_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }
            kmx_ime_sdk_set_softkey_by_state(state);
        }
        break;
    case MMI_IME_SDK_MSG_REDRAW_SOFTKEY_BY_STATE:
        {
            mmi_ime_sdk_state_enum state = (mmi_ime_sdk_state_enum) param0;
            if(!kmx_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }
            kmx_ime_sdk_redraw_softkey_by_state(state);
        }
        break;
    #if defined(__MMI_TOUCH_SCREEN__)
    case MMI_IME_SDK_MSG_IMUI_CONTROL_TRANSLATE_PEN_EVENT:
        {
            mmi_ime_sdk_imui_control_enum control = (mmi_ime_sdk_imui_control_enum) param0;
            mmi_ime_sdk_pen_event_data_struct_p pen_event_data = (mmi_ime_sdk_pen_event_data_struct_p) param1;

            if(!kmx_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }
            ret =  kmx_ime_sdk_imui_control_translate_pen_event(control, pen_event_data);
        }
        break;
    #endif        
    case MMI_IME_SDK_MSG_CONFIG_VK_IN_MTK_STATE:
        {
            if(!kmx_ime_is_ime_support())
            {
                ret = MMI_FALSE;
                break;
            }
        
            #ifdef __MMI_KMX_TOUCH_INPUT__
                if (kmx_input_method_is_keypad_enable() 
                    #if !defined(__NO_HANDWRITING__)
                    && !kmx_input_method_is_handwriting_panel_on()
                    #endif /* #if !defined(__NO_HANDWRITING__) */ 
                    )
                {
                    /* Do not show MTK VK */
                    #ifdef __MMI_IME_FTE_ENHANCE__
                    if (mmi_imc_get_ui_style(MMI_IMC_UI_STYLE_VK_ON))
                    #endif
                    {
                        mmi_ime_sdk_set_visible_control((mmi_ime_sdk_imui_control_enum)MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
                        if (param0)
                        {
                            *((U32*)param0) = MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
                        }                        
                    }
                    #ifdef __MMI_IME_FTE_ENHANCE__
                    else
                    {
                        mmi_ime_sdk_set_hidden_control((mmi_ime_sdk_imui_control_enum)MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
                        if (param0)
                        {
                            *((U32*)param0) = 0;
                        }                        
                    }
                    #endif
                }
                else
                    ret = MMI_FALSE;
            #else
                ret = MMI_FALSE;
            #endif
        }
        break;
    case MMI_IME_SDK_MSG_GET_CURRENT_FLOATING_CONTROL_SET:
        if (kmx_ime_is_ime_support())
        {            
            /* TODO: Add floating controls */
            ret = 0;
        }
        else
        {
            ret = 0;
        }
        break;
    case MMI_IME_SDK_MSG_DRAW_CURRENT_FLOATING_UI_CONTROLS:
        if (kmx_ime_is_ime_support())
        {
            ret = 1;
        }
        else
        {
            ret = 0;
        }
        break;
    case MMI_IME_SDK_MSG_GET_CURRENT_FLOATING_UI_RECT:
        if (kmx_ime_is_ime_support())
        {
            mmi_imc_rect_p r = (mmi_imc_rect_p)param1;
            if (r)
                memset(r, 0, sizeof(*r));
        }        
        break;
    case MMI_IME_SDK_MSG_CHECK_INPUT_MODE_AVAILABLE:
        ret = kmx_check_input_mode_avaliable((mmi_imm_input_mode_enum)param0);
        break;
    case MMI_IME_SDK_MSG_IS_IMUI_CONTROL:
        ret = (U32)kmx_gui_is_gui_control((void*)param0);        
        break;        
    default:
        ret = MMI_FALSE;
        break;
    }
    
    #ifdef _MSC_VER
    {
        const char * msg_name;

        msg_name = kmx_translate_sdk_msg_name(message_id);
        
        printf("-----> Here Come Msg %s, val: %d, ret: %d, p1:%X, p2:%X\r\n", msg_name, message_id, ret, param0, param1);    

    }
    #endif
    return ret;
}

void kmx_ime_vendor_init(void)
{
	mmi_ime_sdk_register_msg_callback(mmi_ime_sdk_vendor_handle_message);
    #ifdef __MMI_IME_PLUG_IN_SETTING__ 
    {
        extern void mmi_input_method_setting_callback(MMI_ID parent_gid);
        mmi_ime_sdk_register_setting_callback(mmi_input_method_setting_callback);
    }
    #endif
}

#ifdef __MMI_QWERTY_KEYPAD_SUPPORT__
static U32 g_kmx_special_key_flag;
static U32 g_kmx_special_key_lock_flags;
    
int kmx_update_special_key_status(mmi_ime_sdk_key_event_data_struct_p key_data, mmi_ime_sdk_special_key_status_struct_p special_key_status)
{
    S16 mmi_key_code, mmi_key_type;
    static S16 pre_down_key_bak;
    static S16 pre_down_key;
    static U32 special_key_flag_bak;
    static U32 special_key_lock_flags_bak;
    
    mmi_key_code = (S16)key_data->mmi_key_code;
    mmi_key_type = (S16)key_data->mmi_key_type;
    
    if (mmi_key_code != KEY_SHIFT && mmi_key_code != KEY_FN)
    {
        if (mmi_key_type == KEY_EVENT_UP)
        {

            if ((g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
                 && !(g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
                 )
            {
                g_kmx_special_key_flag &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;

                g_kmx_special_key_flag = special_key_flag_bak;
                g_kmx_special_key_lock_flags = special_key_lock_flags_bak;
                pre_down_key = pre_down_key_bak;
            }
        }
    }

    if (mmi_key_code == KEY_SHIFT && !(g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
        && !(g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_NUMLOCK))
    {
       if (mmi_key_type == KEY_EVENT_DOWN)
       {
           if (!(g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT))
           {
               g_kmx_special_key_flag = MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT;
			   g_kmx_special_key_lock_flags = 0;
           }
           else if ((g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT)
			        && !(g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT))
           {
               g_kmx_special_key_lock_flags = MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT;
           }
           else if (g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT)
           {
               g_kmx_special_key_flag &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT;
			   g_kmx_special_key_lock_flags &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT;
           }
       }
       else if (mmi_key_type == KEY_EVENT_UP)
       {
           if ((g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT)
                 && !(g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT)
                 && pre_down_key != KEY_SHIFT)
           {
                g_kmx_special_key_flag &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT;
           }
       }
    }
    else if (mmi_key_code == KEY_FN)
    {
       if (mmi_key_type == KEY_EVENT_DOWN)
       {
           if (!(g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN))
           {
               special_key_flag_bak = g_kmx_special_key_flag;
               special_key_lock_flags_bak = g_kmx_special_key_lock_flags;
               pre_down_key_bak = pre_down_key;
               
               g_kmx_special_key_flag = MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;
			   g_kmx_special_key_lock_flags = 0;
           }
           else if ((g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
			        && !(g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN))
           {
               g_kmx_special_key_lock_flags = MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;
           }
           else if (g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
           {
               g_kmx_special_key_flag &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;
			   g_kmx_special_key_lock_flags &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;

               g_kmx_special_key_flag = special_key_flag_bak;
               g_kmx_special_key_lock_flags = special_key_lock_flags_bak;
               pre_down_key = pre_down_key_bak;
           }
       }
       else if (mmi_key_type == KEY_EVENT_UP)
       {
           if ((g_kmx_special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
                 && !(g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN)
                 && pre_down_key != KEY_FN)
           {
               g_kmx_special_key_flag &= ~MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_FN;

               g_kmx_special_key_flag = special_key_flag_bak;
               g_kmx_special_key_lock_flags = special_key_lock_flags_bak;
               pre_down_key = pre_down_key_bak;
           }
       }
    }
    else if (mmi_key_code == KEY_NUM_LOCK)
    {
       if (mmi_key_type == KEY_EVENT_DOWN)
       {
           if (g_kmx_special_key_lock_flags & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_NUMLOCK)
           {
               g_kmx_special_key_flag = 0;
               g_kmx_special_key_lock_flags = 0;
           }
           else 
           {
               g_kmx_special_key_flag = 0;
               g_kmx_special_key_lock_flags = MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_NUMLOCK;
           }
       }
    }
    
    if (mmi_key_type == KEY_EVENT_DOWN)
    {
        pre_down_key = mmi_key_code;
    }

    special_key_status->special_key_flag = g_kmx_special_key_flag;
    special_key_status->special_key_lock_flags = g_kmx_special_key_lock_flags;

    return 1;
}

static int kmx_on_special_key_status_changed(U32 special_key_flag, U32 special_key_lock_flag)
{
    int new_case_info;
    const KMX_INPUT_MODE_ATTRIBUTES* mode_attr;

    g_kmx_special_key_flag = special_key_flag;
    g_kmx_special_key_lock_flags = special_key_lock_flag;
    
    mode_attr = kmx_get_curr_input_mode_attr();
    
    if (mode_attr && (mode_attr->ime == KMX_IME_LATIN_SMART || mode_attr->ime == KMX_IME_LATIN_MULTITAP))    
    {
            
        if (special_key_lock_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT)
        {
            new_case_info = KMX_LANG_UPPERCASE;
        }
        else if (special_key_flag & MMI_FRM_QWERTY_SPECIAL_KEY_FLAG_SHIFT)
        {
            new_case_info = KMX_LANG_INITIALCASE;
        }
        else
        {
           new_case_info = KMX_LANG_LOWERCASE;
        }
        kmx_ime_update_case(new_case_info);
    }
    return 1;
}

static int kmx_on_special_key_status_reset()
{
    g_kmx_special_key_flag = 0;
    g_kmx_special_key_lock_flags = 0;
    return 1;
}

#endif /* __MMI_QWERTY_KEYPAD_SUPPORT__ */

static void kmx_on_cursor_moved(void)
{

}

void kmx_ime_add_ui_all_controls(void)
{
    kmx_gui_setup();
    
    kmx_gui_init();
    
	if (!mmi_ime_sdk_is_in_imui_control_set((mmi_ime_sdk_imui_control_enum)MMI_IME_SDK_IMUI_IME_WINDOW))
		mmi_ime_sdk_add_imui_control((mmi_ime_sdk_imui_control_enum)MMI_IME_SDK_IMUI_IME_WINDOW);

	#ifdef __MMI_KMX_TOUCH_INPUT__	
	if (!mmi_ime_sdk_is_in_imui_control_set((mmi_ime_sdk_imui_control_enum)MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD))
		mmi_ime_sdk_add_imui_control((mmi_ime_sdk_imui_control_enum)MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
	#endif	
}

void kmx_ime_sdk_set_softkey_by_state(mmi_ime_sdk_state_enum state)
{
    switch(state)
    {
    case MMI_IME_SDK_STATE_MULTITAP:
    case MMI_IME_SDK_STATE_CAND_SELECTING:
    case MMI_IME_SDK_STATE_VK_CAND:
    case MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_INPUT:
    case MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP:
    case MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP_HOVER:
        /* LSK */
        mmi_ime_sdk_set_softkey_function(UI_dummy_function, KEY_EVENT_DOWN, MMI_LEFT_SOFTKEY);
        mmi_ime_sdk_set_softkey_function(UI_dummy_function, KEY_EVENT_DOWN, MMI_CENTER_SOFTKEY);
        mmi_ime_sdk_set_softkey_function(mmi_imc_key_group_key_up, KEY_EVENT_UP, MMI_LEFT_SOFTKEY);

        if (state != MMI_IME_SDK_STATE_MULTITAP && state != MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP)
        {
            mmi_ime_sdk_set_softkey_function(mmi_imc_key_group_key_up, KEY_EVENT_UP, MMI_CENTER_SOFTKEY);
            mmi_ime_sdk_set_softkey_label_in_ime_state(NULL, MMI_CENTER_SOFTKEY);
            mmi_ime_sdk_set_softkey_icon_in_ime_state(get_image(IMG_GLOBAL_COMMON_CSK), MMI_CENTER_SOFTKEY);
        }
        mmi_ime_sdk_register_softkey_handler(MMI_CENTER_SOFTKEY);

			if(mmi_frm_kbd_is_key_supported(KEY_CLEAR))
			{
			    mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_CLEAR, KEY_EVENT_DOWN);
                mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_CLEAR, KEY_EVENT_UP);
                mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_CLEAR, KEY_EVENT_LONG_PRESS);
			}
			else
			{
				mmi_ime_sdk_set_softkey_function(mmi_imc_key_group_key_down, KEY_EVENT_DOWN, MMI_RIGHT_SOFTKEY);
                mmi_ime_sdk_set_softkey_function(mmi_imc_key_group_key_long, KEY_EVENT_LONG_PRESS, MMI_RIGHT_SOFTKEY);
                mmi_ime_sdk_set_softkey_function(mmi_imc_key_group_key_up, KEY_EVENT_UP, MMI_RIGHT_SOFTKEY);
			}

            mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_UP_ARROW, KEY_EVENT_DOWN);
            mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_DOWN_ARROW, KEY_EVENT_DOWN);
            mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_RIGHT_ARROW, KEY_EVENT_DOWN);
            mmi_ime_sdk_set_key_handler(mmi_imc_key_group_key_down, KEY_LEFT_ARROW, KEY_EVENT_DOWN);

            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_UP_ARROW, KEY_EVENT_UP);
            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_DOWN_ARROW, KEY_EVENT_UP);
            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_UP_ARROW, KEY_EVENT_LONG_PRESS);
            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_DOWN_ARROW, KEY_EVENT_LONG_PRESS);
            mmi_ime_sdk_clear_key_handler(KEY_UP_ARROW, KEY_EVENT_REPEAT);
            mmi_ime_sdk_clear_key_handler(KEY_DOWN_ARROW, KEY_EVENT_REPEAT);

            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_RIGHT_ARROW, KEY_EVENT_UP);
            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_LEFT_ARROW, KEY_EVENT_UP);
            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_RIGHT_ARROW, KEY_EVENT_LONG_PRESS);
            mmi_ime_sdk_set_key_handler(UI_dummy_function, KEY_LEFT_ARROW, KEY_EVENT_LONG_PRESS);

            mmi_ime_sdk_clear_key_handler(KEY_RIGHT_ARROW, KEY_EVENT_REPEAT);
            mmi_ime_sdk_clear_key_handler(KEY_LEFT_ARROW, KEY_EVENT_REPEAT);
            
        break;
    }
}

void kmx_ime_sdk_redraw_softkey_by_state(mmi_ime_sdk_state_enum state)
{
    switch(state)
    {    
    case MMI_IME_SDK_STATE_CAND_SELECTING:
    case MMI_IME_SDK_STATE_VK_CAND:
    case MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_INPUT:
    case MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP_HOVER:
        /* KMX TODO: When to display save str? */
        /* LSK */
        mmi_ime_sdk_set_softkey_label_in_ime_state((UI_string_type) get_string(STR_GLOBAL_SELECT), MMI_LEFT_SOFTKEY);
        mmi_ime_sdk_set_softkey_icon_in_ime_state(NULL, MMI_LEFT_SOFTKEY);
        mmi_ime_sdk_show_softkey(MMI_LEFT_SOFTKEY);
        mmi_ime_sdk_register_softkey_handler(MMI_LEFT_SOFTKEY);

        /* RSK */
        mmi_ime_sdk_set_softkey_label_in_ime_state((UI_string_type) get_string(STR_GLOBAL_CLEAR), MMI_RIGHT_SOFTKEY); 
        mmi_ime_sdk_set_softkey_icon_in_ime_state(NULL, MMI_RIGHT_SOFTKEY);
        mmi_ime_sdk_show_softkey(MMI_RIGHT_SOFTKEY);
        mmi_ime_sdk_register_softkey_handler(MMI_RIGHT_SOFTKEY);
        break;
    
    case MMI_IME_SDK_STATE_MULTITAP:
    case MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP:
        mmi_ime_sdk_show_softkey(MMI_LEFT_SOFTKEY);
        mmi_ime_sdk_register_softkey_handler(MMI_LEFT_SOFTKEY);

        mmi_ime_sdk_show_softkey(MMI_RIGHT_SOFTKEY);
        mmi_ime_sdk_register_softkey_handler(MMI_RIGHT_SOFTKEY);
        break;
    }
}

#if defined(__MMI_TOUCH_SCREEN__)
U32 kmx_ime_sdk_imui_control_translate_pen_event(
    mmi_ime_sdk_imui_control_enum               control, 
    mmi_ime_sdk_pen_event_data_struct_p         pen_event_data)
{
    U32 ret = MMI_FALSE;

    if (!pen_event_data || !mmi_ime_sdk_is_visible_control(control))
        return MMI_FALSE;
    
    if (control == MMI_IME_SDK_IMUI_IME_WINDOW)
    {
        switch(pen_event_data->event_type)
        {
        case MMI_PEN_EVENT_DOWN:
            {                
                ret = (U32) cstar_pen_down_handler(pen_event_data->pos.x, pen_event_data->pos.y);
            }
            break;
        case MMI_PEN_EVENT_UP:
            {                
                ret = (U32) cstar_pen_up_handler(pen_event_data->pos.x, pen_event_data->pos.y);
            }
            break;
        case MMI_PEN_EVENT_MOVE:
            {                
                ret = (U32) cstar_pen_move_handler(pen_event_data->pos.x, pen_event_data->pos.y);
            }
            break;
        }
    }
    #ifdef __MMI_KMX_TOUCH_INPUT__
    else if (control == MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)
    {
        switch(pen_event_data->event_type)
        {
        case MMI_PEN_EVENT_DOWN:
            {                
                ret = kmx_input_method_pen_down(pen_event_data->pos.x, pen_event_data->pos.y);
            }
            break;
        case MMI_PEN_EVENT_UP:
            {             
                ret = kmx_input_method_pen_up(pen_event_data->pos.x, pen_event_data->pos.y);
            }
            break;
        case MMI_PEN_EVENT_MOVE:
            {             
                ret = kmx_input_method_pen_move(pen_event_data->pos.x, pen_event_data->pos.y);
            }
             break;
        }
    }
    #endif

    return ret;
}
#endif

typedef struct
{
    U8  state;
    U32 imui_set;
}KMX_IME_SDK_STATE_CONTROL_ENTRY;

#ifdef __MMI_TOUCH_SCREEN__

    #if defined(__MMI_IME_FTE_ENHANCE__) 
    static KMX_IME_SDK_STATE_CONTROL_ENTRY g_kmx_ime_sdk_state_set[] = {

        {MMI_IME_SDK_STATE_INITIAL, 0},

        {MMI_IME_SDK_STATE_MULTITAP, 0},

        {MMI_IME_SDK_STATE_CAND_SELECTING, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW)},

        {MMI_IME_SDK_STATE_VK_CAND, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW)},

        #ifdef __MMI_KMX_TOUCH_INPUT__
        {MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_INPUT, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},

        {MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},
        
        {MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP_HOVER, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},
        
        #endif

        {MMI_IME_SDK_STATE_NONE, 0}
    };

    #else
    static KMX_IME_SDK_STATE_CONTROL_ENTRY g_kmx_ime_sdk_state_set[] = {
        
        {MMI_IME_SDK_STATE_INITIAL, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},

        {MMI_IME_SDK_STATE_MULTITAP, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},

        {MMI_IME_SDK_STATE_CAND_SELECTING, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW)},

        {MMI_IME_SDK_STATE_VK_CAND, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD) | MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW)},

        #ifdef __MMI_KMX_TOUCH_INPUT__
        {MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_INPUT, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},

        {MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD)},
        #endif

        {MMI_IME_SDK_STATE_NONE, 0}
    };
    #endif /* __MMI_IME_FTE_ENHANCE__ */
#else
    static KMX_IME_SDK_STATE_CONTROL_ENTRY g_kmx_ime_sdk_state_set[] = {

        {MMI_IME_SDK_STATE_INITIAL, 0},

        {MMI_IME_SDK_STATE_MULTITAP, 0},

        {MMI_IME_SDK_STATE_CAND_SELECTING, MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_IME_WINDOW)},

        {MMI_IME_SDK_STATE_NONE, 0}
    };
#endif

static U32 kmx_ime_sdk_fte_vk_adjust(U32 imui_set);

U32 kmx_ime_sdk_get_ui_set_by_state(mmi_ime_sdk_state_enum state)
{
    KMX_IME_SDK_STATE_CONTROL_ENTRY *e;
    U32 imui_set;
    e = g_kmx_ime_sdk_state_set;
    while(e->state != MMI_IME_SDK_STATE_NONE)
    {
        if (e->state == state)        
            break;        
        e++;
    }

    MMI_ASSERT(e->state != MMI_IME_SDK_STATE_NONE);
    
    imui_set = e->imui_set;
    
    #if defined(__MMI_IME_FTE_ENHANCE__)
    imui_set = kmx_ime_sdk_fte_vk_adjust(imui_set);
    #endif

    #ifdef __MMI_KMX_TOUCH_INPUT__
    if (!kmx_input_method_is_keypad_enable()
        #if !defined(__NO_HANDWRITING__)
        || kmx_input_method_is_handwriting_panel_on()
        #endif /* #if !defined(__NO_HANDWRITING__) */ 
        )
    #endif
    {
        /* Switch vendor vk to mtk vk */
        if (imui_set & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD))
        {
            imui_set &= ~MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
            imui_set |= MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_CONTROL_MTK_VK);
        }
    }
    
    return imui_set;
}

void kmx_ime_sdk_update_controls(U32 imui_set)
{
    mmi_ime_sdk_imui_control_enum control;

    #ifdef __MMI_VIRTUAL_KEYBOARD__
    if (imui_set & MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_CONTROL_MTK_VK))
    {
	    mmi_ime_sdk_set_visible_control(MMI_IME_SDK_IMUI_CONTROL_MTK_VK);        
    }
    else
    {
        mmi_ime_sdk_set_hidden_control(MMI_IME_SDK_IMUI_CONTROL_MTK_VK);
    }
    #endif
    
    for (control = MMI_IME_SDK_IMUI_CONTROL_BEGIN; control <= MMI_IME_SDK_IMUI_CONTROL_LAST; control++)
    {
        if (imui_set & MMI_IME_SDK_IMUI_CONTROL_MASK(control))
        {
		    mmi_ime_sdk_set_visible_control(control);		    
        }
        else
        {
            mmi_ime_sdk_set_hidden_control(control);            
        }    	    
    }
    
    kmx_gui_update_control(imui_set);
}

#if defined(__MMI_IME_FTE_ENHANCE__)
static U32 kmx_ime_sdk_fte_vk_adjust(U32 imui_set)
{    
    if (mmi_imc_get_ui_style(MMI_IMC_UI_STYLE_VK_ON))
    {
        imui_set |= MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
    }
    else
    {
        imui_set &= ~MMI_IME_SDK_IMUI_CONTROL_MASK(MMI_IME_SDK_IMUI_VIRTUAL_KEYBOARD);
    }
    return imui_set;
}
#endif

#ifdef __MMI_KMX_TOUCH_INPUT__
int kmx_ime_is_vk_input_state(mmi_ime_sdk_state_enum state)
{    
    return state >= MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_INPUT && state <= MMI_IME_SDK_STATE_VIRTUAL_KEYBOARD_MULTITAP_HOVER;
}
#endif

int kmx_ime_is_key_input_state(mmi_ime_sdk_state_enum state)
{
    return state >= MMI_IME_SDK_STATE_MULTITAP && state <= MMI_IME_SDK_STATE_VK_CAND;
}

/* static assertion */
/* MMI_IMUI_VENDOR_CONTROL_END <= MMI_IMUI_VENDOR_CONTROL_MAX ...  */

int kmx_ime_is_ime_support(void)
{    
    return g_kmx_is_ime_supported;
}

static U32 kmx_check_input_mode_avaliable(mmi_imm_input_mode_enum input_mode)
{
    switch (input_mode)
    {
        /* Not supported input mode list below: */
    case IMM_INPUT_MODE_SM_MULTITAP_PINYIN:
        return 1;
    }
    return 0;
}

int kmx_ime_is_auto_capitalization_enabled(void)
{
#if defined(__MMI_IME_AUTO_CAPITALIZATION__)
    return (int)mmi_imm_is_auto_capitalization_valid();
#else
    return 0;
#endif
}

S32 kmx_ime_get_curr_allow_input_mode_list(mmi_imm_input_mode_enum *mode_array, S32 max)
{
    S32 num;
    num = mmi_ime_sdk_get_curr_allow_input_mode_list_of_curr_writing_lang(mode_array, max);
    if (!num)
    {
        num = mmi_ime_sdk_get_current_allowed_input_mode_list(mode_array, max);
    }
    return num;
}

#endif