dtrans/source/test/test_dtrans.cxx

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