dtrans/source/test/test_dtrans.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 //------------------------------------------------------------------------
  30 // interface includes
  31 //------------------------------------------------------------------------
  32 #include <com/sun/star/datatransfer/XTransferable.hpp>
  33 #include <com/sun/star/datatransfer/clipboard/XClipboardManager.hpp>
  34 #include <com/sun/star/datatransfer/clipboard/XClipboardOwner.hpp>
  35 #include <com/sun/star/datatransfer/clipboard/XClipboardNotifier.hpp>
  36 #include <com/sun/star/datatransfer/clipboard/XClipboardEx.hpp>
  37 #include <com/sun/star/lang/XComponent.hpp>
  38
  39 //------------------------------------------------------------------------
  40 // other includes
  41 //------------------------------------------------------------------------
  42
  43
  44 #include <cppuhelper/servicefactory.hxx>
  45 #include <cppuhelper/implbase1.hxx>
  46 #include <cppuhelper/implbase2.hxx>
  47 #include <rtl/ustring.hxx>
  48 #include <osl/diagnose.h>
  49
  50 #include <stdlib.h>
  51 #include <stdio.h>
  52 #include <string.h>
  53
  54 //------------------------------------------------------------------------
  55 // my defines
  56 //------------------------------------------------------------------------
  57
  58 #ifdef UNX
  59 #define PATH_SEPERATOR '/'
  60 #else
  61 #define PATH_SEPERATOR '\\'
  62 #endif
  63
  64 #define ENSURE( a, b ) if( !a ) { fprintf( stderr, b "\n" ); exit( -1 ); }
  65 #define TEST( a, b ) fprintf( stderr, "Testing " a ); fprintf( stderr, b ? "passed\n" : "FAILED\n" )
  66 #define PERFORM( a, b ) fprintf( stderr, "Performing " a); b; fprintf( stderr, "done\n" )
  67 #define TRACE( a ) fprintf( stderr, a )
  68
  69 //------------------------------------------------------------------------
  70 //  namespaces
  71 //------------------------------------------------------------------------
  72
  73 using namespace ::rtl;
  74 using namespace ::std;
  75 using namespace ::cppu;
  76 using namespace ::com::sun::star::container;
  77 using namespace ::com::sun::star::datatransfer;
  78 using namespace ::com::sun::star::datatransfer::clipboard;
  79 using namespace ::com::sun::star::uno;
  80 using namespace ::com::sun::star::io;
  81 using namespace ::com::sun::star::lang;
  82
  83 //------------------------------------------------------------------------
  84 //  globals
  85 //------------------------------------------------------------------------
  86
  87 const char * app = NULL;
  88
  89 //------------------------------------------------------------------------
  90 //  ClipboardOwner
  91 //------------------------------------------------------------------------
  92
  93 class ClipboardOwner : public WeakImplHelper1< XClipboardOwner >
  94 {
  95     Reference< XClipboard >    m_xClipboard;
  96     Reference< XTransferable > m_xTransferable;
  97
  98     sal_uInt32 m_nReceivedLostOwnerships;
  99
 100 public:
 101     ClipboardOwner();
 102
 103     //--------------------------------------------------------------------
 104     // XClipboardOwner
 105     //--------------------------------------------------------------------
 106
 107     virtual void SAL_CALL lostOwnership( const Reference< XClipboard >& xClipboard, const Reference< XTransferable >& xTrans ) throw(RuntimeException);
 108
 109     sal_uInt32 receivedLostOwnerships() { return m_nReceivedLostOwnerships; };
 110     Reference< XClipboard >    lostOwnershipClipboardValue() { return m_xClipboard; }
 111     Reference< XTransferable > lostOwnershipTransferableValue() { return m_xTransferable; };
 112 };
 113
 114 //------------------------------------------------------------------------
 115 //  ctor
 116 //------------------------------------------------------------------------
 117
 118 ClipboardOwner::ClipboardOwner():
 119     m_nReceivedLostOwnerships( 0 )
 120 {
 121 }
 122
 123 //------------------------------------------------------------------------
 124 //  lostOwnership
 125 //------------------------------------------------------------------------
 126
 127 void SAL_CALL ClipboardOwner::lostOwnership( const Reference< XClipboard >& xClipboard, const Reference< XTransferable >& xTrans )
 128     throw(RuntimeException)
 129 {
 130     m_nReceivedLostOwnerships++;
 131     m_xClipboard = xClipboard;
 132     m_xTransferable = xTrans;
 133 }
 134
 135 //------------------------------------------------------------------------
 136 //  ClipboardListener
 137 //------------------------------------------------------------------------
 138
 139 class ClipboardListener : public WeakImplHelper1< XClipboardListener >
 140 {
 141     Reference< XClipboard >    m_xClipboard;
 142     Reference< XTransferable > m_xTransferable;
 143
 144     sal_uInt32 m_nReceivedChangedContentsEvents;
 145
 146 public:
 147     ClipboardListener();
 148
 149     //--------------------------------------------------------------------
 150     // XClipboardOwner
 151     //--------------------------------------------------------------------
 152
 153     virtual void SAL_CALL changedContents( const ClipboardEvent& event ) throw(RuntimeException);
 154
 155     //--------------------------------------------------------------------
 156     // XEventListener
 157     //--------------------------------------------------------------------
 158
 159     virtual void SAL_CALL disposing( const EventObject& event ) throw(RuntimeException);
 160
 161     sal_uInt32 receivedChangedContentsEvents() { return m_nReceivedChangedContentsEvents; };
 162     Reference< XClipboard >    changedContentsEventClipboardValue() { return m_xClipboard; }
 163     Reference< XTransferable > changedContentsEventTransferableValue() { return m_xTransferable; };
 164 };
 165
 166 //------------------------------------------------------------------------
 167 //  ctor
 168 //------------------------------------------------------------------------
 169
 170 ClipboardListener::ClipboardListener():
 171     m_nReceivedChangedContentsEvents( 0 )
 172 {
 173 }
 174
 175 //------------------------------------------------------------------------
 176 //  changedContents
 177 //------------------------------------------------------------------------
 178
 179 void SAL_CALL ClipboardListener::changedContents( const ClipboardEvent& event )
 180     throw(RuntimeException)
 181 {
 182     m_nReceivedChangedContentsEvents++;
 183     m_xClipboard = Reference< XClipboard > (event.Source, UNO_QUERY);
 184     m_xTransferable = event.Contents;
 185 }
 186
 187 //------------------------------------------------------------------------
 188 //  disposing
 189 //------------------------------------------------------------------------
 190
 191 void SAL_CALL ClipboardListener::disposing( const EventObject& event )
 192     throw(RuntimeException)
 193 {
 194 }
 195
 196 //------------------------------------------------------------------------
 197 //  StringTransferable
 198 //------------------------------------------------------------------------
 199
 200 class StringTransferable : public WeakImplHelper2< XClipboardOwner, XTransferable >
 201 {
 202 public:
 203     StringTransferable( );
 204
 205     //--------------------------------------------------------------------
 206     // XTransferable
 207     //--------------------------------------------------------------------
 208
 209     virtual Any SAL_CALL getTransferData( const DataFlavor& aFlavor ) throw(UnsupportedFlavorException, IOException, RuntimeException);
 210     virtual Sequence< DataFlavor > SAL_CALL getTransferDataFlavors(  ) throw(RuntimeException);
 211     virtual sal_Bool SAL_CALL isDataFlavorSupported( const DataFlavor& aFlavor ) throw(RuntimeException);
 212
 213     //--------------------------------------------------------------------
 214     // XClipboardOwner
 215     //--------------------------------------------------------------------
 216
 217     virtual void SAL_CALL lostOwnership( const Reference< XClipboard >& xClipboard, const Reference< XTransferable >& xTrans ) throw(RuntimeException);
 218
 219     sal_Bool receivedLostOwnership() { return m_receivedLostOwnership; };
 220     void clearReceivedLostOwnership() { m_receivedLostOwnership = sal_False; };
 221
 222 private:
 223     Sequence< DataFlavor > m_seqDFlv;
 224     OUString               m_Data;
 225     sal_Bool               m_receivedLostOwnership;
 226 };
 227
 228 //------------------------------------------------------------------------
 229 //  ctor
 230 //------------------------------------------------------------------------
 231
 232 StringTransferable::StringTransferable( ) :
 233     m_seqDFlv( 1 ),
 234     m_receivedLostOwnership( sal_False ),
 235     m_Data( OUString("clipboard test content") )
 236 {
 237     DataFlavor df;
 238
 239     /*
 240     df.MimeType = L"text/plain; charset=unicode";
 241     df.DataType = getCppuType( ( OUString* )0 );
 242
 243     m_seqDFlv[0] = df;
 244     */
 245
 246     //df.MimeType = L"text/plain; charset=windows1252";
 247     df.MimeType = OUString("text/html");
 248     df.DataType = getCppuType( ( Sequence< sal_Int8 >* )0 );
 249
 250     m_seqDFlv[0] = df;
 251 }
 252
 253 //------------------------------------------------------------------------
 254 //  getTransferData
 255 //------------------------------------------------------------------------
 256
 257 Any SAL_CALL StringTransferable::getTransferData( const DataFlavor& aFlavor )
 258     throw(UnsupportedFlavorException, IOException, RuntimeException)
 259 {
 260     Any anyData;
 261
 262     /*if ( aFlavor == m_seqDFlv[0] )
 263     {
 264         anyData = makeAny( m_Data );
 265     } */
 266
 267     return anyData;
 268 }
 269
 270 //------------------------------------------------------------------------
 271 //  getTransferDataFlavors
 272 //------------------------------------------------------------------------
 273
 274 Sequence< DataFlavor > SAL_CALL StringTransferable::getTransferDataFlavors(  )
 275     throw(RuntimeException)
 276 {
 277     return m_seqDFlv;
 278 }
 279
 280 //------------------------------------------------------------------------
 281 //  isDataFlavorSupported
 282 //------------------------------------------------------------------------
 283
 284 sal_Bool SAL_CALL StringTransferable::isDataFlavorSupported( const DataFlavor& aFlavor )
 285     throw(RuntimeException)
 286 {
 287     sal_Int32 nLength = m_seqDFlv.getLength( );
 288     sal_Bool bRet     = sal_False;
 289
 290 //  for ( sal_Int32 i = 0; i < nLength; ++i )
 291 //  {
 292 //      if ( m_seqDFlv[i] == aFlavor )
 293 //      {
 294 //          bRet = sal_True;
 295 //          break;
 296 //      }
 297 //  }
 298
 299     return bRet;
 300 }
 301
 302 //------------------------------------------------------------------------
 303 //  lostOwnership
 304 //------------------------------------------------------------------------
 305
 306 void SAL_CALL StringTransferable::lostOwnership( const Reference< XClipboard >& xClipboard, const Reference< XTransferable >& xTrans )
 307     throw(RuntimeException)
 308 {
 309     m_receivedLostOwnership = sal_True;
 310 }
 311
 312 //------------------------------------------------------------------------
 313 //  main
 314 //------------------------------------------------------------------------
 315
 316 int SAL_CALL main( int argc, const char* argv[] )
 317 {
 318     OUString aRegistry;
 319
 320     //------------------------------------------------------------------
 321     // check command line parameters
 322     //------------------------------------------------------------------
 323
 324     if ( NULL == ( app = strrchr( argv[0], PATH_SEPERATOR ) ) )
 325         app = argv[0];
 326     else
 327         app++;
 328
 329     for( int n = 1; n < argc; n++ )
 330     {
 331         if( strncmp( argv[n], "-r", 2 ) == 0 )
 332         {
 333             if( strlen( argv[n] ) > 2 )
 334                 aRegistry = OUString::createFromAscii( argv[n] + 2 );
 335             else if ( n + 1 < argc )
 336                 aRegistry = OUString::createFromAscii( argv[++n] );
 337         }
 338     }
 339
 340     if( aRegistry.isEmpty( ) )
 341         fprintf( stderr, "Usage: %s -r full-path-to-applicat.rdb\n", app );
 342
 343     //------------------------------------------------------------------
 344     // create service manager
 345     //------------------------------------------------------------------
 346     Reference< XMultiServiceFactory > xServiceManager;
 347
 348     try
 349     {
 350         xServiceManager = createRegistryServiceFactory( aRegistry, sal_True );
 351         ENSURE( xServiceManager.is(), "*** ERROR *** service manager could not be created." );
 352
 353         //--------------------------------------------------------------
 354         // create an instance of GenericClipboard service
 355         //--------------------------------------------------------------
 356
 357         Sequence< Any > arguments(1);
 358         arguments[0] = makeAny( OUString("generic") );
 359
 360         Reference< XClipboard > xClipboard( xServiceManager->createInstanceWithArguments(
 361             OUString("com.sun.star.datatransfer.clipboard.GenericClipboard"),
 362             arguments ), UNO_QUERY );
 363
 364         ENSURE( xClipboard.is(), "*** ERROR *** generic clipboard service could not be created." );
 365
 366         Reference< XClipboardNotifier > xClipboardNotifier( xClipboard, UNO_QUERY );
 367         Reference< XClipboardListener > xClipboardListener = new ClipboardListener();
 368         ClipboardListener * pListener = (ClipboardListener *) xClipboardListener.get();
 369
 370         if( xClipboardNotifier.is() )
 371             xClipboardNotifier->addClipboardListener( xClipboardListener );
 372
 373         //--------------------------------------------------------------
 374         // run various tests on clipboard implementation
 375         //--------------------------------------------------------------
 376
 377         TRACE( "\n*** testing generic clipboard service ***\n" );
 378
 379         Reference< XTransferable > xContents = new StringTransferable();
 380         Reference< XClipboardOwner > xOwner  = new ClipboardOwner();
 381         ClipboardOwner *pOwner = (ClipboardOwner *) xOwner.get();
 382
 383         TEST( "initial contents (none): ", xClipboard->getContents().is() == sal_False );
 384
 385         PERFORM( "update on contents with clipboard owner: ", xClipboard->setContents( xContents, xOwner ) );
 386         TEST( "current clipboard contents: ", xContents == xClipboard->getContents() );
 387
 388         if( xClipboardNotifier.is() )
 389         {
 390             TEST( "if received changedContents notifications: ", pListener->receivedChangedContentsEvents() > 0 );
 391             TEST( "if received exactly 1 changedContents notification: ", pListener->receivedChangedContentsEvents() == 1 );
 392             TEST( "if received changedContents notification for correct clipboard: ", pListener->changedContentsEventClipboardValue() == xClipboard );
 393             TEST( "if received changedContents notification for correct clipboard: ", pListener->changedContentsEventTransferableValue() == xContents );
 394         }
 395
 396         PERFORM( "update on contents without data (clear): ", xClipboard->setContents( Reference< XTransferable >(), Reference< XClipboardOwner >() ) );
 397         TEST( "if received lostOwnership message(s): ", pOwner->receivedLostOwnerships() > 0 );
 398         TEST( "if received exactly 1 lostOwnership message: ", pOwner->receivedLostOwnerships() == 1 );
 399         TEST( "if received lostOwnership message for the correct clipboard: ", pOwner->lostOwnershipClipboardValue() == xClipboard );
 400         TEST( "if received lostOwnership message for the correct transferable: ", pOwner->lostOwnershipTransferableValue() == xContents );
 401         TEST( "current clipboard contents (none): ", xClipboard->getContents().is() == sal_False );
 402
 403         if( xClipboardNotifier.is() )
 404         {
 405             TEST( "if received changedContents notifications: ", pListener->receivedChangedContentsEvents() > 1 );
 406             TEST( "if received exactly 1 changedContents notification: ", pListener->receivedChangedContentsEvents() == 2 );
 407             TEST( "if received changedContents notification for correct clipboard: ", pListener->changedContentsEventClipboardValue() == xClipboard );
 408             TEST( "if received changedContents notification for correct transferable: ", ! pListener->changedContentsEventTransferableValue().is() );
 409         }
 410
 411         PERFORM( "update on contents without clipboard owner: ", xClipboard->setContents( xContents, Reference< XClipboardOwner >() ) );
 412         TEST( "that no further lostOwnership messages were received: ", pOwner->receivedLostOwnerships() == 1 );
 413         TEST( "current clipboard contents: ", xContents == xClipboard->getContents() );
 414
 415         if( xClipboardNotifier.is() )
 416         {
 417             TEST( "if received changedContents notifications: ", pListener->receivedChangedContentsEvents() > 2 );
 418             TEST( "if received exactly 1 changedContents notification: ", pListener->receivedChangedContentsEvents() == 3 );
 419             TEST( "if received changedContents notification for correct clipboard: ", pListener->changedContentsEventClipboardValue() == xClipboard );
 420             TEST( "if received changedContents notification for correct transferable: ", pListener->changedContentsEventTransferableValue() == xContents );
 421         }
 422
 423
 424         PERFORM( "update on contents without data (clear): ", xClipboard->setContents( Reference< XTransferable >(), Reference< XClipboardOwner >() ) );
 425         TEST( "that no further lostOwnership messages were received: ", pOwner->receivedLostOwnerships() == 1 );
 426         TEST( "current clipboard contents (none): ", xClipboard->getContents().is() == sal_False );
 427
 428         if( xClipboardNotifier.is() )
 429         {
 430             TEST( "if received changedContents notifications: ", pListener->receivedChangedContentsEvents() > 3 );
 431             TEST( "if received exactly 1 changedContents notification: ", pListener->receivedChangedContentsEvents() == 4 );
 432             TEST( "if received changedContents notification for correct clipboard: ", pListener->changedContentsEventClipboardValue() == xClipboard );
 433             TEST( "if received changedContents notification for correct transferable: ", ! pListener->changedContentsEventTransferableValue().is() );
 434         }
 435
 436         //--------------------------------------------------------------
 437         // create an instance of ClipboardManager service
 438         //--------------------------------------------------------------
 439
 440         Reference< XClipboardManager > xClipboardManager( xServiceManager->createInstance(
 441             OUString("com.sun.star.datatransfer.clipboard.ClipboardManager") ), UNO_QUERY );
 442
 443         ENSURE( xClipboardManager.is(), "*** ERROR *** clipboard manager service could not be created." );
 444
 445         //--------------------------------------------------------------
 446         // run various tests on clipboard manager implementation
 447         //--------------------------------------------------------------
 448
 449         TRACE( "\n*** testing clipboard manager service ***\n" );
 450
 451         TEST( "initial number of clipboards (0): ", xClipboardManager->listClipboardNames().getLength() == 0 );
 452         PERFORM( "insertion of generic clipboard: ", xClipboardManager->addClipboard( xClipboard ) );
 453         TEST( "number of inserted clipboards (1): ", xClipboardManager->listClipboardNames().getLength() == 1 );
 454         TEST( "name of inserted clipboard (generic): ", xClipboardManager->listClipboardNames()[0] == OUString("generic") );
 455         TEST( "inserted clipboard instance: ", xClipboardManager->getClipboard( OUString("generic") ) == xClipboard );
 456         PERFORM( "removal of generic clipboard: ", xClipboardManager->removeClipboard( OUString("generic") ) );
 457         TEST( "number of inserted clipboards (0): ", xClipboardManager->listClipboardNames().getLength() == 0 );
 458         TRACE( "Testing inserted clipboard instance (none): " );
 459         try
 460         {
 461             xClipboardManager->getClipboard( OUString("generic") );
 462             TRACE( "FAILED\n" );
 463         }
 464         catch (const NoSuchElementException&)
 465         {
 466             TRACE( "passed\n" );
 467         }
 468     }
 469
 470     catch (const Exception&)
 471     {
 472         ENSURE( sal_False, "*** ERROR *** exception caught." );
 473     }
 474
 475     //--------------------------------------------------------------------
 476     // shutdown the service manager
 477     //--------------------------------------------------------------------
 478
 479     // query XComponent interface
 480     Reference< XComponent > xComponent( xServiceManager, UNO_QUERY );
 481
 482     ENSURE( xComponent.is(), "*** ERROR *** service manager does not support XComponent." );
 483
 484     // Dispose and clear factory
 485     xComponent->dispose();
 486     xServiceManager.clear();
 487
 488     fprintf( stderr, "Done.\n" );
 489     return 0;
 490 }
 491
 492
 493 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */