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