adaptors/x11/imf-manager-impl-x.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <imf-manager-impl.h>
  20
  21 // EXTERNAL INCLUDES
  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>
  25
  26 // INTERNAL INCLUDES
  27 #include <adaptor.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"
  33
  34 namespace Dali
  35 {
  36
  37 namespace Internal
  38 {
  39
  40 namespace Adaptor
  41 {
  42
  43 namespace
  44 {
  45 #if defined(DEBUG_ENABLED)
  46 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_IMF_MANAGER");
  47 #endif
  48
  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)
  51 {
  52   size_t length = 0;
  53
  54   if ((leadByte & 0x80) == 0 )          //ASCII character (lead bit zero)
  55   {
  56     length = 1;
  57   }
  58   else if (( leadByte & 0xe0 ) == 0xc0 ) //110x xxxx
  59   {
  60     length = 2;
  61   }
  62   else if (( leadByte & 0xf0 ) == 0xe0 ) //1110 xxxx
  63   {
  64     length = 3;
  65   }
  66   else if (( leadByte & 0xf8 ) == 0xf0 ) //1111 0xxx
  67   {
  68     length = 4;
  69   }
  70
  71   return length;
  72 }
  73
  74 // Static function calls used by ecore 'c' style callback registration
  75 void Commit( void *data, Ecore_IMF_Context *imfContext, void *event_info )
  76 {
  77   if ( data )
  78   {
  79     ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
  80     imfManager->CommitReceived( data, imfContext, event_info );
  81   }
  82 }
  83
  84 void PreEdit( void *data, Ecore_IMF_Context *imfContext, void *event_info )
  85 {
  86   if ( data )
  87   {
  88     ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
  89     imfManager->PreEditChanged( data, imfContext, event_info );
  90   }
  91 }
  92
  93 Eina_Bool ImfRetrieveSurrounding(void *data, Ecore_IMF_Context *imfContext, char** text, int* cursorPosition )
  94 {
  95   if ( data )
  96   {
  97     ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
  98     return imfManager->RetrieveSurrounding( data, imfContext, text, cursorPosition );
  99   }
 100   else
 101   {
 102     return false;
 103   }
 104 }
 105
 106 /**
 107  * Called when an IMF delete surrounding event is received.
 108  * Here we tell the application that it should delete a certain range.
 109  */
 110 void ImfDeleteSurrounding( void *data, Ecore_IMF_Context *imfContext, void *event_info )
 111 {
 112   if ( data )
 113   {
 114     ImfManager* imfManager = reinterpret_cast< ImfManager* > ( data );
 115     imfManager->DeleteSurrounding( data, imfContext, event_info );
 116   }
 117 }
 118
 119 BaseHandle Create()
 120 {
 121   return ImfManager::Get();
 122 }
 123
 124 TypeRegistration IMF_MANAGER_TYPE( typeid(Dali::ImfManager), typeid(Dali::BaseHandle), Create );
 125
 126 } // unnamed namespace
 127
 128 bool ImfManager::IsAvailable()
 129 {
 130   bool available( false );
 131
 132   Dali::SingletonService service( SingletonService::Get() );
 133   if ( service )
 134   {
 135     available = service.GetSingleton( typeid( Dali::ImfManager ) );
 136   }
 137
 138   return available;
 139 }
 140
 141 Dali::ImfManager ImfManager::Get()
 142 {
 143   Dali::ImfManager manager;
 144
 145   Dali::SingletonService service( SingletonService::Get() );
 146   if ( service )
 147   {
 148     // Check whether the singleton is already created
 149     Dali::BaseHandle handle = service.GetSingleton( typeid( Dali::ImfManager ) );
 150     if( handle )
 151     {
 152       // If so, downcast the handle
 153       manager = Dali::ImfManager( dynamic_cast< ImfManager* >( handle.GetObjectPtr() ) );
 154     }
 155     else if ( Adaptor::IsAvailable() )
 156     {
 157       // Create instance and register singleton only if the adaptor is available
 158
 159       Adaptor& adaptorImpl( Adaptor::GetImplementation( Adaptor::Get() ) );
 160       Any nativeWindow = adaptorImpl.GetNativeWindowHandle();
 161
 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) );
 165       if (ecoreXwin)
 166       {
 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().
 170
 171         manager = Dali::ImfManager( new ImfManager( ecoreXwin ) );
 172         service.Register( typeid( manager ), manager );
 173       }
 174       else
 175       {
 176         DALI_LOG_ERROR("Failed to get native window handle");
 177       }
 178     }
 179   }
 180
 181   return manager;
 182 }
 183
 184 ImfManager::ImfManager( Ecore_X_Window ecoreXwin )
 185 : mIMFContext(),
 186   mIMFCursorPosition( 0 ),
 187   mSurroundingText(),
 188   mRestoreAfterFocusLost( false ),
 189   mIdleCallbackConnected( false )
 190 {
 191   ecore_imf_init();
 192   CreateContext( ecoreXwin );
 193
 194   ConnectCallbacks();
 195   VirtualKeyboard::ConnectCallbacks( mIMFContext );
 196 }
 197
 198 ImfManager::~ImfManager()
 199 {
 200   VirtualKeyboard::DisconnectCallbacks( mIMFContext );
 201   DisconnectCallbacks();
 202
 203   DeleteContext();
 204   ecore_imf_shutdown();
 205 }
 206
 207 void ImfManager::CreateContext( Ecore_X_Window ecoreXwin )
 208 {
 209   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::CreateContext\n" );
 210
 211   const char *contextId = ecore_imf_context_default_id_get();
 212   if( contextId )
 213   {
 214     mIMFContext = ecore_imf_context_add( contextId );
 215
 216     if( mIMFContext )
 217     {
 218       if( ecoreXwin )
 219       {
 220         ecore_imf_context_client_window_set( mIMFContext, reinterpret_cast<void*>( ecoreXwin ) );
 221       }
 222     }
 223     else
 224     {
 225       DALI_LOG_WARNING("IMF Unable to get IMF Context\n");
 226     }
 227   }
 228   else
 229   {
 230     DALI_LOG_WARNING("IMF Unable to get IMF Context\n");
 231   }
 232 }
 233
 234 void ImfManager::DeleteContext()
 235 {
 236   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DeleteContext\n" );
 237
 238   if ( mIMFContext )
 239   {
 240     mIMFContext = NULL;
 241   }
 242 }
 243
 244 // Callbacks for predicitive text support.
 245 void ImfManager::ConnectCallbacks()
 246 {
 247   if ( mIMFContext )
 248   {
 249     DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::ConnectCallbacks\n" );
 250
 251     ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_PREEDIT_CHANGED,    PreEdit,    this );
 252     ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_COMMIT,             Commit,     this );
 253     ecore_imf_context_event_callback_add( mIMFContext, ECORE_IMF_CALLBACK_DELETE_SURROUNDING, ImfDeleteSurrounding, this );
 254
 255     ecore_imf_context_retrieve_surrounding_callback_set( mIMFContext, ImfRetrieveSurrounding, this);
 256   }
 257 }
 258
 259 void ImfManager::DisconnectCallbacks()
 260 {
 261   if ( mIMFContext )
 262   {
 263     DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DisconnectCallbacks\n" );
 264
 265     ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_PREEDIT_CHANGED,    PreEdit );
 266     ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_COMMIT,             Commit );
 267     ecore_imf_context_event_callback_del( mIMFContext, ECORE_IMF_CALLBACK_DELETE_SURROUNDING, ImfDeleteSurrounding );
 268
 269     // We do not need to unset the retrieve surrounding callback.
 270   }
 271 }
 272
 273 void ImfManager::Activate()
 274 {
 275   // Reset mIdleCallbackConnected
 276   mIdleCallbackConnected = false;
 277
 278   if ( mIMFContext )
 279   {
 280     DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Activate\n" );
 281
 282     ecore_imf_context_focus_in( mIMFContext );
 283
 284     // emit keyboard activated signal
 285     Dali::ImfManager handle( this );
 286     mActivatedSignal.Emit( handle );
 287   }
 288 }
 289
 290 void ImfManager::Deactivate()
 291 {
 292   if( mIMFContext )
 293   {
 294     DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Deactivate\n" );
 295
 296     Reset();
 297     ecore_imf_context_focus_out( mIMFContext );
 298   }
 299
 300   // Reset mIdleCallbackConnected
 301   mIdleCallbackConnected = false;
 302 }
 303
 304 void ImfManager::Reset()
 305 {
 306   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::Reset\n" );
 307
 308   if ( mIMFContext )
 309   {
 310     ecore_imf_context_reset( mIMFContext );
 311   }
 312 }
 313
 314 Ecore_IMF_Context* ImfManager::GetContext()
 315 {
 316   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetContext\n" );
 317
 318   return mIMFContext;
 319 }
 320
 321 bool ImfManager::RestoreAfterFocusLost() const
 322 {
 323   return mRestoreAfterFocusLost;
 324 }
 325
 326 void ImfManager::SetRestoreAfterFocusLost( bool toggle )
 327 {
 328   mRestoreAfterFocusLost = toggle;
 329 }
 330
 331 /**
 332  * Called when an IMF Pre-Edit changed event is received.
 333  * We are still predicting what the user is typing.  The latest string is what the IMF module thinks
 334  * the user wants to type.
 335  */
 336 void ImfManager::PreEditChanged( void*, Ecore_IMF_Context* imfContext, void* event_info )
 337 {
 338   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::PreEditChanged\n" );
 339
 340   char* preEditString( NULL );
 341   int cursorPosition( 0 );
 342   Eina_List* attrs = NULL;
 343   Eina_List* l = NULL;
 344
 345   Ecore_IMF_Preedit_Attr* attr;
 346
 347   // Retrieves attributes as well as the string the cursor position offset from start of pre-edit string.
 348   // the attributes (attrs) is used in languages that use the soft arrows keys to insert characters into a current pre-edit string.
 349   ecore_imf_context_preedit_string_with_attributes_get( imfContext, &preEditString, &attrs, &cursorPosition );
 350
 351   if ( attrs )
 352   {
 353     // iterate through the list of attributes getting the type, start and end position.
 354     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) ) ))
 355     {
 356 #ifdef DALI_PROFILE_UBUNTU
 357       if ( attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB3 ) // (Ecore_IMF)
 358 #else // DALI_PROFILE_UBUNTU
 359       if ( attr->preedit_type == ECORE_IMF_PREEDIT_TYPE_SUB4 ) // (Ecore_IMF)
 360 #endif // DALI_PROFILE_UBUNTU
 361       {
 362         // 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.
 363
 364         size_t visualCharacterIndex = 0;
 365         size_t byteIndex = 0;
 366
 367         // iterate through null terminated string checking each character's position against the given byte position ( attr->end_index ).
 368         const char leadByte = preEditString[byteIndex];
 369         while( leadByte != '\0' )
 370         {
 371           // attr->end_index is provided as a byte position not character and we need to know the character position.
 372           const size_t currentSequenceLength = Utf8SequenceLength( leadByte ); // returns number of bytes used to represent character.
 373           if ( byteIndex == attr->end_index )
 374           {
 375             cursorPosition = visualCharacterIndex;
 376             break;
 377             // end loop as found cursor position that matches byte position
 378           }
 379           else
 380           {
 381             byteIndex += currentSequenceLength; // jump to next character
 382             visualCharacterIndex++;  // increment character count so we know our position for when we get a match
 383           }
 384
 385           DALI_ASSERT_DEBUG( visualCharacterIndex < strlen( preEditString ));
 386         }
 387       }
 388     }
 389   }
 390
 391   if ( Dali::Adaptor::IsAvailable() )
 392   {
 393     Dali::ImfManager handle( this );
 394     Dali::ImfManager::ImfEventData imfEventData( Dali::ImfManager::PREEDIT, preEditString, cursorPosition, 0 );
 395     Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfEventData );
 396
 397     if ( callbackData.update )
 398     {
 399       SetCursorPosition( callbackData.cursorPosition );
 400       SetSurroundingText( callbackData.currentText );
 401
 402       NotifyCursorPosition();
 403     }
 404
 405     if ( callbackData.preeditResetRequired )
 406     {
 407       Reset();
 408     }
 409   }
 410   free( preEditString );
 411 }
 412
 413 void ImfManager::CommitReceived( void*, Ecore_IMF_Context* imfContext, void* event_info )
 414 {
 415   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::CommitReceived\n" );
 416
 417   if ( Dali::Adaptor::IsAvailable() )
 418   {
 419     const std::string keyString( static_cast<char*>( event_info ) );
 420
 421     Dali::ImfManager handle( this );
 422     Dali::ImfManager::ImfEventData imfEventData( Dali::ImfManager::COMMIT, keyString, 0, 0 );
 423     Dali::ImfManager::ImfCallbackData callbackData = mEventSignal.Emit( handle, imfEventData );
 424
 425     if( callbackData.update )
 426     {
 427       SetCursorPosition( callbackData.cursorPosition );
 428       SetSurroundingText( callbackData.currentText );
 429
 430       NotifyCursorPosition();
 431     }
 432   }
 433 }
 434
 435 /**
 436  * Called when an IMF retrieve surround event is received.
 437  * Here the IMF module wishes to know the string we are working with and where within the string the cursor is
 438  * We need to signal the application to tell us this information.
 439  */
 440 Eina_Bool ImfManager::RetrieveSurrounding( void* data, Ecore_IMF_Context* imfContext, char** text, int* cursorPosition )
 441 {
 442   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::RetrieveSurrounding\n" );
 443
 444   Dali::ImfManager::ImfEventData imfData( Dali::ImfManager::GETSURROUNDING, std::string(), 0, 0 );
 445   Dali::ImfManager handle( this );
 446   mEventSignal.Emit( handle, imfData );
 447
 448   if( text )
 449   {
 450     *text = strdup( mSurroundingText.c_str() );
 451   }
 452
 453   if( cursorPosition )
 454   {
 455     *cursorPosition = mIMFCursorPosition;
 456   }
 457
 458   return EINA_TRUE;
 459 }
 460
 461 /**
 462  * Called when an IMF delete surrounding event is received.
 463  * Here we tell the application that it should delete a certain range.
 464  */
 465 void ImfManager::DeleteSurrounding( void* data, Ecore_IMF_Context* imfContext, void* event_info )
 466 {
 467   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::DeleteSurrounding\n" );
 468
 469   if( Dali::Adaptor::IsAvailable() )
 470   {
 471     Ecore_IMF_Event_Delete_Surrounding* deleteSurroundingEvent = static_cast<Ecore_IMF_Event_Delete_Surrounding*>( event_info );
 472
 473     Dali::ImfManager::ImfEventData imfData( Dali::ImfManager::DELETESURROUNDING, std::string(), deleteSurroundingEvent->offset, deleteSurroundingEvent->n_chars );
 474     Dali::ImfManager handle( this );
 475     mEventSignal.Emit( handle, imfData );
 476   }
 477 }
 478
 479 void ImfManager::NotifyCursorPosition()
 480 {
 481   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::NotifyCursorPosition\n" );
 482
 483   if( mIMFContext )
 484   {
 485     ecore_imf_context_cursor_position_set( mIMFContext, mIMFCursorPosition );
 486   }
 487 }
 488
 489 void ImfManager::SetCursorPosition( unsigned int cursorPosition )
 490 {
 491   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::SetCursorPosition\n" );
 492
 493   mIMFCursorPosition = static_cast<int>( cursorPosition );
 494 }
 495
 496 unsigned int ImfManager::GetCursorPosition() const
 497 {
 498   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetCursorPosition\n" );
 499
 500   return static_cast<unsigned int>( mIMFCursorPosition );
 501 }
 502
 503 void ImfManager::SetSurroundingText( const std::string& text )
 504 {
 505   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::SetSurroundingText\n" );
 506
 507   mSurroundingText = text;
 508 }
 509
 510 const std::string& ImfManager::GetSurroundingText() const
 511 {
 512   DALI_LOG_INFO( gLogFilter, Debug::General, "ImfManager::GetSurroundingText\n" );
 513
 514   return mSurroundingText;
 515 }
 516
 517 } // Adaptor
 518
 519 } // Internal
 520
 521 } // Dali