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>
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 );
121 return ImfManager::Get();
124 TypeRegistration IMF_MANAGER_TYPE( typeid(Dali::ImfManager), typeid(Dali::BaseHandle), Create );
126 } // unnamed namespace
128 bool ImfManager::IsAvailable()
130 bool available( false );
132 Dali::SingletonService service( SingletonService::Get() );
135 available = service.GetSingleton( typeid( Dali::ImfManager ) );
141 Dali::ImfManager ImfManager::Get()
143 Dali::ImfManager manager;
145 Dali::SingletonService service( SingletonService::Get() );
148 // Check whether the singleton is already created
149 Dali::BaseHandle handle = service.GetSingleton( typeid( Dali::ImfManager ) );
152 // If so, downcast the handle
153 manager = Dali::ImfManager( dynamic_cast< ImfManager* >( handle.GetObjectPtr() ) );
155 else if ( Adaptor::IsAvailable() )
157 // Create instance and register singleton only if the adaptor is available
159 Adaptor& adaptorImpl( Adaptor::GetImplementation( Adaptor::Get() ) );
160 Any nativeWindow = adaptorImpl.GetNativeWindowHandle();
162 // The Ecore_X_Window needs to use the ImfManager.
163 // Only when the render surface is window, we can get the Ecore_X_Window.
164 Ecore_X_Window ecoreXwin( AnyCast<Ecore_X_Window>(nativeWindow) );
167 // If we fail to get Ecore_X_Window, we can't use the ImfManager correctly.
168 // Thus you have to call "ecore_imf_context_client_window_set" somewhere.
169 // In EvasPlugIn, this function is called in EvasPlugin::ConnectEcoreEvent().
171 manager = Dali::ImfManager( new ImfManager( ecoreXwin ) );
172 service.Register( typeid( manager ), manager );
176 DALI_LOG_ERROR("Failed to get native window handle");
184 ImfManager::ImfManager( Ecore_X_Window ecoreXwin )
186 mIMFCursorPosition( 0 ),
187 mSurroundingText(""),
188 mRestoreAfterFocusLost( false ),
189 mIdleCallbackConnected( false ),
193 CreateContext( ecoreXwin );
196 VirtualKeyboard::ConnectCallbacks( mIMFContext );
199 ImfManager::~ImfManager()
201 VirtualKeyboard::DisconnectCallbacks( mIMFContext );
202 DisconnectCallbacks();
205 ecore_imf_shutdown();
208 void ImfManager::CreateContext( Ecore_X_Window ecoreXwin )
210 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::CreateContext\n" );
212 const char *contextId = ecore_imf_context_default_id_get();
215 mIMFContext = ecore_imf_context_add( contextId );
221 ecore_imf_context_client_window_set( mIMFContext, reinterpret_cast<void*>( ecoreXwin ) );
226 DALI_LOG_WARNING("IMF Unable to get IMF Context\n");
231 DALI_LOG_WARNING("IMF Unable to get IMF Context\n");
235 void ImfManager::DeleteContext()
237 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DeleteContext\n" );
245 // Callbacks for predicitive text support.
246 void ImfManager::ConnectCallbacks()
250 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::ConnectCallbacks\n" );
252 ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_PREEDIT_CHANGED, PreEdit, this );
253 ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_COMMIT, Commit, this );
254 ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_DELETE_SURROUNDING, ImfDeleteSurrounding, this );
256 ecore_imf_context_retrieve_surrounding_callback_set( mIMFContext, ImfRetrieveSurrounding, this);
260 void ImfManager::DisconnectCallbacks()
264 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DisconnectCallbacks\n" );
266 ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_PREEDIT_CHANGED, PreEdit );
267 ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_COMMIT, Commit );
268 ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_DELETE_SURROUNDING, ImfDeleteSurrounding );
270 // We do not need to unset the retrieve surrounding callback.
274 void ImfManager::Activate()
276 // Reset mIdleCallbackConnected
277 mIdleCallbackConnected = false;
281 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Activate\n" );
283 ecore_imf_context_focus_in( mIMFContext );
285 // emit keyboard activated signal
286 Dali::ImfManager handle( this );
287 mActivatedSignal.Emit( handle );
291 void ImfManager::Deactivate()
295 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Deactivate\n" );
298 ecore_imf_context_focus_out( mIMFContext );
301 // Reset mIdleCallbackConnected
302 mIdleCallbackConnected = false;
305 void ImfManager::Reset()
307 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Reset\n" );
311 ecore_imf_context_reset( mIMFContext );
315 Ecore_IMF_Context* ImfManager::GetContext()
317 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetContext\n" );
322 bool ImfManager::RestoreAfterFocusLost() const
324 return mRestoreAfterFocusLost;
327 void ImfManager::SetRestoreAfterFocusLost( bool toggle )
329 mRestoreAfterFocusLost = toggle;
333 * Called when an IMF Pre-Edit changed event is received.
334 * We are still predicting what the user is typing. The latest string is what the IMF module thinks
335 * the user wants to type.
337 void ImfManager::PreEditChanged( void *, Ecore_IMF_Context *imfContext, void *event_info )
339 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::PreEditChanged\n" );
341 char *preEditString( NULL );
342 int cursorPosition( 0 );
343 Eina_List *attrs = NULL;
346 Ecore_IMF_Preedit_Attr *attr;
348 // Retrieves attributes as well as the string the cursor position offset from start of pre-edit string.
349 // the attributes (attrs) is used in languages that use the soft arrows keys to insert characters into a current pre-edit string.
350 ecore_imf_context_preedit_string_with_attributes_get( imfContext, &preEditString, &attrs, &cursorPosition );
354 // iterate through the list of attributes getting the type, start and end position.
355 for ( l = attrs, (attr = (Ecore_IMF_Preedit_Attr*)eina_list_data_get(l) ); l; l = eina_list_next(l), ( attr = (Ecore_IMF_Preedit_Attr*)eina_list_data_get(l) ))
357 #ifdef DALI_PROFILE_UBUNTU
358 if ( attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB3 ) // (Ecore_IMF)
359 #else // DALI_PROFILE_UBUNTU
360 if ( attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB4 ) // (Ecore_IMF)
361 #endif // DALI_PROFILE_UBUNTU
363 // 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.
365 size_t visualCharacterIndex = 0;
366 size_t byteIndex = 0;
368 // iterate through null terminated string checking each character's position against the given byte position ( attr->end_index ).
369 while ( preEditString[byteIndex] != '\0' )
371 // attr->end_index is provided as a byte position not character and we need to know the character position.
372 size_t currentSequenceLength = Utf8SequenceLength(preEditString[byteIndex]); // returns number of bytes used to represent character.
373 if ( byteIndex == attr->end_index )
375 cursorPosition = visualCharacterIndex;
377 // end loop as found cursor position that matches byte position
381 byteIndex += currentSequenceLength; // jump to next character
382 visualCharacterIndex++; // increment character count so we know our position for when we get a match
385 DALI_ASSERT_DEBUG( visualCharacterIndex < strlen( preEditString ));
391 if ( Dali::Adaptor::IsAvailable() )
393 std::string keyString ( preEditString );
394 int numberOfChars( 0 );
396 Dali::ImfManager handle( this );
397 Dali::ImfManager::ImfEventData imfEventData ( Dali::ImfManager::PREEDIT, keyString, cursorPosition, numberOfChars );
398 Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfEventData );
400 if ( callbackData.update )
402 SetCursorPosition( callbackData.cursorPosition );
403 SetSurroundingText( callbackData.currentText );
405 NotifyCursorPosition();
408 if ( callbackData.preeditResetRequired )
413 free( preEditString );
416 void ImfManager::CommitReceived( void *, Ecore_IMF_Context *imfContext, void *event_info )
418 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::CommitReceived\n" );
420 if ( Dali::Adaptor::IsAvailable() )
422 const std::string keyString( (char *)event_info );
423 const int cursorOffset( 0 );
424 const int numberOfChars( 0 );
426 Dali::ImfManager handle( this );
427 Dali::ImfManager::ImfEventData imfEventData ( Dali::ImfManager::COMMIT, keyString, cursorOffset, numberOfChars );
428 Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfEventData );
430 if ( callbackData.update )
432 SetCursorPosition( callbackData.cursorPosition );
433 SetSurroundingText( callbackData.currentText );
435 NotifyCursorPosition();
441 * Called when an IMF retrieve surround event is received.
442 * Here the IMF module wishes to know the string we are working with and where within the string the cursor is
443 * We need to signal the application to tell us this information.
445 Eina_Bool ImfManager::RetrieveSurrounding( void *data, Ecore_IMF_Context *imfContext, char** text, int* cursorPosition )
447 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::RetrieveSurrounding\n" );
449 std::string keyString ( "" );
450 int cursorOffset( 0 );
451 int numberOfChars( 0 );
453 Dali::ImfManager::ImfEventData imfData ( Dali::ImfManager::GETSURROUNDING , keyString, cursorOffset, numberOfChars );
454 Dali::ImfManager handle( this );
455 mEventSignal.Emit( handle, imfData );
459 std::string surroundingText( GetSurroundingText() );
461 if ( !surroundingText.empty() )
463 *text = strdup( surroundingText.c_str() );
467 *text = strdup( "" );
471 if ( cursorPosition )
473 *cursorPosition = GetCursorPosition();
481 * Called when an IMF delete surrounding event is received.
482 * Here we tell the application that it should delete a certain range.
484 void ImfManager::DeleteSurrounding( void *data, Ecore_IMF_Context *imfContext, void *event_info )
486 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DeleteSurrounding\n" );
488 if ( Dali::Adaptor::IsAvailable() )
490 Ecore_IMF_Event_Delete_Surrounding* deleteSurroundingEvent = (Ecore_IMF_Event_Delete_Surrounding*) event_info;
492 const std::string keyString( "" );
493 const int cursorOffset( deleteSurroundingEvent->offset );
494 const int numberOfChars( deleteSurroundingEvent->n_chars );
496 Dali::ImfManager::ImfEventData imfData ( Dali::ImfManager::DELETESURROUNDING , keyString, cursorOffset, numberOfChars );
497 Dali::ImfManager handle( this );
498 mEventSignal.Emit( handle, imfData );
502 void ImfManager::NotifyCursorPosition()
504 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::NotifyCursorPosition\n" );
508 ecore_imf_context_cursor_position_set( mIMFContext, mIMFCursorPosition );
512 int ImfManager::GetCursorPosition()
514 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetCursorPosition\n" );
516 return mIMFCursorPosition;
519 void ImfManager::SetCursorPosition( unsigned int cursorPosition )
521 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::SetCursorPosition\n" );
523 mIMFCursorPosition = ( int )cursorPosition;
526 void ImfManager::SetSurroundingText( std::string text )
528 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::SetSurroundingText\n" );
530 mSurroundingText = text;
533 std::string ImfManager::GetSurroundingText()
535 DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetSurroundingText\n" );
537 return mSurroundingText;