adaptors/x11/clipboard-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 "clipboard-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <Ecore_X.h>
  23 #include <dali/public-api/object/any.h>
  24 #include <dali/public-api/object/type-registry.h>
  25 #include <dali/integration-api/debug.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <adaptor-impl.h>
  29 #include <ecore-x-window-interface.h>
  30 #include <singleton-service-impl.h>
  31
  32 namespace //unnamed namespace
  33 {
  34 const char* const CBHM_WINDOW = "CBHM_XWIN";
  35 const char* const CBHM_MSG = "CBHM_MSG";
  36 const char* const CBHM_ITEM = "CBHM_ITEM";
  37 const char* const CBHM_cCOUNT = "CBHM_cCOUNT";
  38 const char* const CBHM_ERROR = "CBHM_ERROR";
  39 const char* const SET_ITEM = "SET_ITEM";
  40 const char* const SHOW = "show0";
  41 const char* const HIDE = "cbhm_hide";
  42 }
  43
  44 ///////////////////////////////////////////////////////////////////////////////////////////////////
  45 // Clipboard
  46 ///////////////////////////////////////////////////////////////////////////////////////////////////
  47
  48 namespace Dali
  49 {
  50
  51 namespace Internal
  52 {
  53
  54 namespace Adaptor
  55 {
  56
  57 namespace
  58 {
  59 BaseHandle Create()
  60 {
  61   BaseHandle handle( Clipboard::Get() );
  62
  63   if ( !handle && Adaptor::IsAvailable() )
  64   {
  65     Dali::SingletonService service( SingletonService::Get() );
  66     if ( service )
  67     {
  68       Adaptor& adaptorImpl( Adaptor::GetImplementation( Adaptor::Get() ) );
  69
  70       // The Ecore_X_Window needs to use the Clipboard.
  71       // Only when the render surface is window, we can get the Ecore_X_Window.
  72       Ecore_X_Window ecoreXwin( 0 );
  73       Dali::RenderSurface& surface( adaptorImpl.GetSurface() );
  74       if( surface.GetType() == Dali::RenderSurface::WINDOW )
  75       {
  76         ecoreXwin = AnyCast< Ecore_X_Window >( adaptorImpl.GetSurface().GetSurface() );
  77       }
  78
  79       // If we fail to get Ecore_X_Window, we can't use the Clipboard correctly.
  80       // Thus you have to call "ecore_imf_context_client_window_set" somewhere.
  81       // In EvasPlugIn, this function is called in EvasPlugin::ConnectEcoreEvent().
  82       Dali::Clipboard clipboard = Dali::Clipboard( new Clipboard( ecoreXwin ) );
  83       service.Register( typeid( clipboard ), clipboard );
  84       handle = clipboard;
  85     }
  86   }
  87
  88   return handle;
  89 }
  90 TypeRegistration CLIPBOARD_TYPE( typeid(Dali::Clipboard), typeid(Dali::BaseHandle), Create, true /* Create Instance At Startup */ );
  91
  92 } // unnamed namespace
  93
  94 Clipboard::Clipboard( Ecore_X_Window ecoreXwin)
  95 {
  96   mApplicationWindow = ecoreXwin;
  97 }
  98
  99 Clipboard::~Clipboard()
 100 {
 101 }
 102
 103 Dali::Clipboard Clipboard::Get()
 104 {
 105   Dali::Clipboard clipboard;
 106
 107   Dali::SingletonService service( SingletonService::Get() );
 108   if ( service )
 109   {
 110     // Check whether the singleton is already created
 111     Dali::BaseHandle handle = service.GetSingleton( typeid( Dali::Clipboard ) );
 112     if(handle)
 113     {
 114       // If so, downcast the handle
 115       clipboard = Dali::Clipboard( dynamic_cast< Clipboard* >( handle.GetObjectPtr() ) );
 116     }
 117   }
 118
 119   return clipboard;
 120 }
 121 bool Clipboard::SetItem(const std::string &itemData )
 122 {
 123   Ecore_X_Window cbhmWin = ECore::WindowInterface::GetWindow();
 124   Ecore_X_Atom atomCbhmItem = ecore_x_atom_get( CBHM_ITEM );
 125   Ecore_X_Atom dataType = ECORE_X_ATOM_STRING;
 126
 127   // Set item (property) to send
 128   ecore_x_window_prop_property_set( cbhmWin, atomCbhmItem, dataType, 8, const_cast<char*>( itemData.c_str() ), itemData.length() + 1 );
 129   ecore_x_sync();
 130
 131   // Trigger sending of item (property)
 132   Ecore_X_Atom atomCbhmMsg = ecore_x_atom_get( CBHM_MSG );
 133   ECore::WindowInterface::SendXEvent(ecore_x_display_get(), cbhmWin, False, NoEventMask, atomCbhmMsg, 8, SET_ITEM );
 134   return true;
 135 }
 136
 137 /*
 138  * Get string at given index of clipboard
 139  */
 140 std::string Clipboard::GetItem( unsigned int index )  // change string to a Dali::Text object.
 141 {
 142   if ( index >= NumberOfItems() )
 143   {
 144     return "";
 145   }
 146
 147   std::string emptyString( "" );
 148   char sendBuf[20];
 149
 150   snprintf( sendBuf, 20,  "%s%d", CBHM_ITEM, index );
 151   Ecore_X_Atom xAtomCbhmItem = ecore_x_atom_get( sendBuf );
 152   Ecore_X_Atom xAtomItemType = 0;
 153
 154   std::string clipboardString( ECore::WindowInterface::GetWindowProperty(xAtomCbhmItem, &xAtomItemType, index ) );
 155   if ( !clipboardString.empty() )
 156   {
 157     Ecore_X_Atom xAtomCbhmError = ecore_x_atom_get( CBHM_ERROR );
 158     if ( xAtomItemType != xAtomCbhmError )
 159     {
 160       return clipboardString;
 161     }
 162    }
 163    return emptyString;
 164 }
 165
 166 /*
 167  * Get number of items in clipboard
 168  */
 169 unsigned int Clipboard::NumberOfItems()
 170 {
 171   Ecore_X_Atom xAtomCbhmCountGet = ecore_x_atom_get( CBHM_cCOUNT );
 172
 173   std::string ret( ECore::WindowInterface::GetWindowProperty( xAtomCbhmCountGet, NULL, 0 ) );
 174   int count = -1;
 175
 176   if ( !ret.empty() )
 177   {
 178     count = atoi( ret.c_str() );
 179   }
 180
 181   return count;
 182 }
 183
 184 /**
 185  * Show clipboard window
 186  * Function to send message to show the Clipboard (cbhm) as no direct API available
 187  * Reference elementary/src/modules/ctxpopup_copypasteUI/cbhm_helper.c
 188  */
 189 void Clipboard::ShowClipboard()
 190 {
 191   // Claim the ownership of the SECONDARY selection.
 192   ecore_x_selection_secondary_set(mApplicationWindow, "", 1);
 193   Ecore_X_Window cbhmWin = ECore::WindowInterface::GetWindow();
 194
 195   // Launch the clipboard window
 196   Ecore_X_Atom atomCbhmMsg = ecore_x_atom_get( CBHM_MSG );
 197   ECore::WindowInterface::SendXEvent( ecore_x_display_get(), cbhmWin, False, NoEventMask, atomCbhmMsg, 8, SHOW );
 198 }
 199
 200 void Clipboard::HideClipboard()
 201 {
 202   Ecore_X_Window cbhmWin = ECore::WindowInterface::GetWindow();
 203   // Launch the clipboard window
 204   Ecore_X_Atom atomCbhmMsg = ecore_x_atom_get( CBHM_MSG );
 205   ECore::WindowInterface::SendXEvent( ecore_x_display_get(), cbhmWin, False, NoEventMask, atomCbhmMsg, 8, HIDE );
 206
 207   // release the ownership of SECONDARY selection
 208   ecore_x_selection_secondary_clear();
 209 }
 210
 211
 212 } // namespace Adaptor
 213
 214 } // namespace Internal
 215
 216 } // namespace Dali