2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <imf-manager-impl.h>
22 #include <dali/public-api/events/key-event.h>
23 #include <dali/public-api/object/type-registry.h>
24 #include <dali/integration-api/debug.h>
28 #include <window-render-surface.h>
29 #include <adaptor-impl.h>
30 #include <singleton-service-impl.h>
31 #include <virtual-keyboard-impl.h>
32 #include "ecore-virtual-keyboard.h"
45 #if defined(DEBUG_ENABLED)
46 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_IMF_MANAGER");
49 // Currently this code is internal to dali/dali/internal/event/text/utf8.h but should be made Public and used from there instead.
50 size_t Utf8SequenceLength(const unsigned char leadByte)
54 if ((leadByte & 0x80) == 0 ) //ASCII character (lead bit zero)
58 else if (( leadByte & 0xe0 ) == 0xc0 ) //110x xxxx
62 else if (( leadByte & 0xf0 ) == 0xe0 ) //1110 xxxx
66 else if (( leadByte & 0xf8 ) == 0xf0 ) //1111 0xxx
74 // Static function calls used by ecore 'c' style callback registration
75 void Commit( void *data, Ecore_IMF_Context *imfContext, void *event_info )
79 ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
80 imfManager->CommitReceived( data, imfContext, event_info );
84 void PreEdit( void *data, Ecore_IMF_Context *imfContext, void *event_info )
88 ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
89 imfManager->PreEditChanged( data, imfContext, event_info );
93 Eina_Bool ImfRetrieveSurrounding(void *data, Ecore_IMF_Context *imfContext, char** text, int* cursorPosition )
97 ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
98 return imfManager->RetrieveSurrounding( data, imfContext, text, cursorPosition );
107 * Called when an IMF delete surrounding event is received.
108 * Here we tell the application that it should delete a certain range.
110 void ImfDeleteSurrounding( void *data, Ecore_IMF_Context *imfContext, void *event_info )
114 ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
115 imfManager->DeleteSurrounding( data, imfContext, event_info );
119 } // unnamed namespace
121 bool ImfManager::IsAvailable()
123 bool available( false );
125 Dali::SingletonService service( SingletonService::Get() );
128 available = service.GetSingleton( typeid( Dali::ImfManager ) );
134 Dali::ImfManager ImfManager::Get()
136 Dali::ImfManager manager;
138 Dali::SingletonService service( SingletonService::Get() );
141 // Check whether the singleton is already created
142 Dali::BaseHandle handle = service.GetSingleton( typeid( Dali::ImfManager ) );
145 // If so, downcast the handle
146 manager = Dali::ImfManager( dynamic_cast< ImfManager* >( handle.GetObjectPtr() ) );
148 else if ( Adaptor::IsAvailable() )
150 // Create instance and register singleton only if the adaptor is available
152 Adaptor& adaptorImpl( Adaptor::GetImplementation( Adaptor::Get() ) );
153 Any nativeWindow = adaptorImpl.GetNativeWindowHandle();
155 // The Ecore_X_Window needs to use the ImfManager.
156 // Only when the render surface is window, we can get the Ecore_X_Window.
157 Ecore_X_Window ecoreXwin( AnyCast<Ecore_X_Window>(nativeWindow) );
160 // If we fail to get Ecore_X_Window, we can't use the ImfManager correctly.
161 // Thus you have to call "ecore_imf_context_client_window_set" somewhere.
162 // In EvasPlugIn, this function is called in EvasPlugin::ConnectEcoreEvent().
164 manager = Dali::ImfManager( new ImfManager( ecoreXwin ) );
165 service.Register( typeid( manager ), manager );
169 DALI_LOG_ERROR("Failed to get native window handle\n");
177 ImfManager::ImfManager( Ecore_X_Window ecoreXwin )
179 mIMFCursorPosition( 0 ),
181 mRestoreAfterFocusLost( false ),
182 mIdleCallbackConnected( false )
185 CreateContext( ecoreXwin );
188 VirtualKeyboard::ConnectCallbacks( mIMFContext );
191 ImfManager::~ImfManager()
193 VirtualKeyboard::DisconnectCallbacks( mIMFContext );
194 DisconnectCallbacks();
197 ecore_imf_shutdown();
200 void ImfManager::CreateContext( Ecore_X_Window ecoreXwin )
202 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::CreateContext\n" );
204 const char *contextId = ecore_imf_context_default_id_get();
207 mIMFContext = ecore_imf_context_add( contextId );
213 ecore_imf_context_client_window_set( mIMFContext, reinterpret_cast<void*>( ecoreXwin ) );
218 DALI_LOG_WARNING("IMF Unable to get IMF Context\n");
223 DALI_LOG_WARNING("IMF Unable to get IMF Context\n");
227 void ImfManager::DeleteContext()
229 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DeleteContext\n" );
237 // Callbacks for predicitive text support.
238 void ImfManager::ConnectCallbacks()
242 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::ConnectCallbacks\n" );
244 ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_PREEDIT_CHANGED, PreEdit, this );
245 ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_COMMIT, Commit, this );
246 ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_DELETE_SURROUNDING, ImfDeleteSurrounding, this );
248 ecore_imf_context_retrieve_surrounding_callback_set( mIMFContext, ImfRetrieveSurrounding, this);
252 void ImfManager::DisconnectCallbacks()
256 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DisconnectCallbacks\n" );
258 ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_PREEDIT_CHANGED, PreEdit );
259 ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_COMMIT, Commit );
260 ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_DELETE_SURROUNDING, ImfDeleteSurrounding );
262 // We do not need to unset the retrieve surrounding callback.
266 void ImfManager::Activate()
268 // Reset mIdleCallbackConnected
269 mIdleCallbackConnected = false;
273 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Activate\n" );
275 ecore_imf_context_focus_in( mIMFContext );
277 // emit keyboard activated signal
278 Dali::ImfManager handle( this );
279 mActivatedSignal.Emit( handle );
283 void ImfManager::Deactivate()
287 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Deactivate\n" );
290 ecore_imf_context_focus_out( mIMFContext );
293 // Reset mIdleCallbackConnected
294 mIdleCallbackConnected = false;
297 void ImfManager::Reset()
299 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Reset\n" );
303 ecore_imf_context_reset( mIMFContext );
307 Ecore_IMF_Context* ImfManager::GetContext()
309 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetContext\n" );
314 bool ImfManager::RestoreAfterFocusLost() const
316 return mRestoreAfterFocusLost;
319 void ImfManager::SetRestoreAfterFocusLost( bool toggle )
321 mRestoreAfterFocusLost = toggle;
325 * Called when an IMF Pre-Edit changed event is received.
326 * We are still predicting what the user is typing. The latest string is what the IMF module thinks
327 * the user wants to type.
329 void ImfManager::PreEditChanged( void*, Ecore_IMF_Context* imfContext, void* event_info )
331 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::PreEditChanged\n" );
333 char* preEditString( NULL );
334 int cursorPosition( 0 );
335 Eina_List* attrs = NULL;
338 Ecore_IMF_Preedit_Attr* attr;
340 // Retrieves attributes as well as the string the cursor position offset from start of pre-edit string.
341 // the attributes (attrs) is used in languages that use the soft arrows keys to insert characters into a current pre-edit string.
342 ecore_imf_context_preedit_string_with_attributes_get( imfContext, &preEditString, &attrs, &cursorPosition );
346 // iterate through the list of attributes getting the type, start and end position.
347 for ( l = attrs, (attr = static_cast<Ecore_IMF_Preedit_Attr*>( eina_list_data_get(l) ) ); l; l = eina_list_next(l), ( attr = static_cast<Ecore_IMF_Preedit_Attr*>( eina_list_data_get(l) ) ))
349 #ifdef DALI_PROFILE_UBUNTU
350 if ( attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB3 ) // (Ecore_IMF)
351 #else // DALI_PROFILE_UBUNTU
352 if ( attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB4 ) // (Ecore_IMF)
353 #endif // DALI_PROFILE_UBUNTU
355 // check first byte so know how many bytes a character is represented by as keyboard returns cursor position in bytes. Which is different for some languages.
357 size_t visualCharacterIndex = 0;
358 size_t byteIndex = 0;
360 // iterate through null terminated string checking each character's position against the given byte position ( attr->end_index ).
361 const char leadByte = preEditString[byteIndex];
362 while( leadByte != '\0' )
364 // attr->end_index is provided as a byte position not character and we need to know the character position.
365 const size_t currentSequenceLength = Utf8SequenceLength( leadByte ); // returns number of bytes used to represent character.
366 if ( byteIndex == attr->end_index )
368 cursorPosition = visualCharacterIndex;
370 // end loop as found cursor position that matches byte position
374 byteIndex += currentSequenceLength; // jump to next character
375 visualCharacterIndex++; // increment character count so we know our position for when we get a match
378 DALI_ASSERT_DEBUG( visualCharacterIndex < strlen( preEditString ));
384 if ( Dali::Adaptor::IsAvailable() )
386 Dali::ImfManager handle( this );
387 Dali::ImfManager::ImfEventData imfEventData( Dali::ImfManager::PREEDIT, preEditString, cursorPosition, 0 );
388 Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfEventData );
390 if( callbackData.update )
392 mIMFCursorPosition = static_cast<int>( callbackData.cursorPosition );
394 NotifyCursorPosition();
397 if( callbackData.preeditResetRequired )
402 free( preEditString );
405 void ImfManager::CommitReceived( void*, Ecore_IMF_Context* imfContext, void* event_info )
407 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::CommitReceived\n" );
409 if ( Dali::Adaptor::IsAvailable() )
411 const std::string keyString( static_cast<char*>( event_info ) );
413 Dali::ImfManager handle( this );
414 Dali::ImfManager::ImfEventData imfEventData( Dali::ImfManager::COMMIT, keyString, 0, 0 );
415 Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfEventData );
417 if( callbackData.update )
419 mIMFCursorPosition = static_cast<int>( callbackData.cursorPosition );
421 NotifyCursorPosition();
427 * Called when an IMF retrieve surround event is received.
428 * Here the IMF module wishes to know the string we are working with and where within the string the cursor is
429 * We need to signal the application to tell us this information.
431 Eina_Bool ImfManager::RetrieveSurrounding( void* data, Ecore_IMF_Context* imfContext, char** text, int* cursorPosition )
433 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::RetrieveSurrounding\n" );
435 Dali::ImfManager::ImfEventData imfData( Dali::ImfManager::GETSURROUNDING, std::string(), 0, 0 );
436 Dali::ImfManager handle( this );
437 Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfData );
439 if( callbackData.update )
443 *text = strdup( callbackData.currentText.c_str() );
448 mIMFCursorPosition = static_cast<int>( callbackData.cursorPosition );
449 *cursorPosition = mIMFCursorPosition;
457 * Called when an IMF delete surrounding event is received.
458 * Here we tell the application that it should delete a certain range.
460 void ImfManager::DeleteSurrounding( void* data, Ecore_IMF_Context* imfContext, void* event_info )
462 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DeleteSurrounding\n" );
464 if( Dali::Adaptor::IsAvailable() )
466 Ecore_IMF_Event_Delete_Surrounding* deleteSurroundingEvent = static_cast<Ecore_IMF_Event_Delete_Surrounding*>( event_info );
468 Dali::ImfManager::ImfEventData imfData( Dali::ImfManager::DELETESURROUNDING, std::string(), deleteSurroundingEvent->offset, deleteSurroundingEvent->n_chars );
469 Dali::ImfManager handle( this );
470 Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfData );
472 if( callbackData.update )
474 mIMFCursorPosition = static_cast<int>( callbackData.cursorPosition );
476 NotifyCursorPosition();
481 void ImfManager::NotifyCursorPosition()
483 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::NotifyCursorPosition\n" );
487 ecore_imf_context_cursor_position_set( mIMFContext, mIMFCursorPosition );
491 void ImfManager::SetCursorPosition( unsigned int cursorPosition )
493 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::SetCursorPosition\n" );
495 mIMFCursorPosition = static_cast<int>( cursorPosition );
498 unsigned int ImfManager::GetCursorPosition() const
500 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetCursorPosition\n" );
502 return static_cast<unsigned int>( mIMFCursorPosition );
505 void ImfManager::SetSurroundingText( const std::string& text )
507 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::SetSurroundingText\n" );
509 mSurroundingText = text;
512 const std::string& ImfManager::GetSurroundingText() const
514 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetSurroundingText\n" );
516 return mSurroundingText;