svtools/source/svdde/ddecli.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ddecli.cxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svtools.hxx"
  33
  34 #define UNICODE
  35 #include <string.h> // memset
  36 #include "ddeimp.hxx"
  37 #include <svtools/svdde.hxx>
  38
  39 #include <osl/thread.h>
  40 #include <tools/debug.hxx>
  41 #include <vcl/svapp.hxx>
  42 #include <vos/mutex.hxx>
  43
  44 // static DWORD        hDdeInst  = NULL;
  45 // static short        nInstance = 0;
  46
  47 // DdeConnections*     DdeConnection::pConnections = NULL;
  48
  49 DdeInstData* ImpInitInstData()
  50 {
  51     DdeInstData* pData = new DdeInstData;
  52     memset( pData,0,sizeof(DdeInstData) );
  53     DdeInstData** ppInst = (DdeInstData**)GetAppData( SHL_SVDDE );
  54     *ppInst = pData;
  55     return pData;
  56 }
  57
  58 void ImpDeinitInstData()
  59 {
  60     DdeInstData** ppInst = (DdeInstData**)GetAppData( SHL_SVDDE );
  61     delete (*ppInst);
  62     *ppInst = 0;
  63 }
  64
  65
  66 struct DdeImp
  67 {
  68     HCONV   hConv;
  69     long    nStatus;
  70 };
  71
  72 // --- DdeInternat::CliCallback() ----------------------------------
  73
  74 HDDEDATA CALLBACK DdeInternal::CliCallback(
  75             WORD nCode, WORD nCbType, HCONV hConv, HSZ, HSZ hText2,
  76             HDDEDATA hData, DWORD nInfo1, DWORD )
  77 {
  78     HDDEDATA nRet = DDE_FNOTPROCESSED;
  79     DdeConnections&     rAll = (DdeConnections&)DdeConnection::GetConnections();
  80     DdeConnection*      self = 0;
  81
  82     DdeInstData* pInst = ImpGetInstData();
  83     DBG_ASSERT(pInst,"SVDDE:No instance data");
  84
  85     for ( self = rAll.First(); self; self = rAll.Next() )
  86         if ( self->pImp->hConv == hConv )
  87             break;
  88
  89     if( self )
  90     {
  91         DdeTransaction* t;
  92         BOOL bFound = FALSE;
  93         for( t = self->aTransactions.First(); t; t = self->aTransactions.Next() )
  94         {
  95             switch( nCode )
  96             {
  97                 case XTYP_XACT_COMPLETE:
  98                     if( (DWORD)t->nId == nInfo1 )
  99                     {
 100                         nCode = t->nType & (XCLASS_MASK | XTYP_MASK);
 101                         t->bBusy = FALSE;
 102                         t->Done( 0 != hData );
 103                         bFound = TRUE;
 104                     }
 105                     break;
 106
 107                 case XTYP_DISCONNECT:
 108                     self->pImp->hConv = DdeReconnect( hConv );
 109                     self->pImp->nStatus = self->pImp->hConv
 110                                     ? DMLERR_NO_ERROR
 111                                     : DdeGetLastError( pInst->hDdeInstCli );
 112                     t = 0;
 113                     nRet = 0;
 114                     bFound = TRUE;
 115                     break;
 116
 117                 case XTYP_ADVDATA:
 118                     bFound = BOOL( *t->pName == hText2 );
 119                     break;
 120             }
 121             if( bFound )
 122                 break;
 123         }
 124
 125         if( t )
 126         {
 127             switch( nCode )
 128             {
 129             case XTYP_ADVDATA:
 130                 if( !hData )
 131                 {
 132                     ((DdeLink*) t)->Notify();
 133                     nRet = (HDDEDATA)DDE_FACK;
 134                     break;
 135                 }
 136                 // kein break;
 137
 138             case XTYP_REQUEST:
 139                 if( !hData && XTYP_REQUEST == nCode )
 140                 {
 141
 142                 }
 143
 144                 DdeData d;
 145                 d.pImp->hData = hData;
 146                 d.pImp->nFmt  = DdeData::GetInternalFormat( nCbType );
 147                 d.Lock();
 148                 t->Data( &d );
 149                 nRet = (HDDEDATA)DDE_FACK;
 150                 break;
 151             }
 152         }
 153     }
 154     return nRet;
 155 }
 156
 157 // --- DdeConnection::DdeConnection() ------------------------------
 158
 159 DdeConnection::DdeConnection( const String& rService, const String& rTopic )
 160 {
 161     pImp = new DdeImp;
 162     pImp->nStatus  = DMLERR_NO_ERROR;
 163     pImp->hConv    = NULL;
 164
 165     DdeInstData* pInst = ImpGetInstData();
 166     if( !pInst )
 167         pInst = ImpInitInstData();
 168     pInst->nRefCount++;
 169     pInst->nInstanceCli++;
 170     if ( !pInst->hDdeInstCli )
 171     {
 172         pImp->nStatus = DdeInitialize( &pInst->hDdeInstCli,
 173                                        (PFNCALLBACK)DdeInternal::CliCallback,
 174                                        APPCLASS_STANDARD | APPCMD_CLIENTONLY |
 175                                        CBF_FAIL_ALLSVRXACTIONS |
 176                                        CBF_SKIP_REGISTRATIONS  |
 177                                        CBF_SKIP_UNREGISTRATIONS, 0L );
 178         pInst->pConnections = new DdeConnections;
 179     }
 180
 181     pService = new DdeString( pInst->hDdeInstCli, rService );
 182     pTopic   = new DdeString( pInst->hDdeInstCli, rTopic );
 183
 184     if ( pImp->nStatus == DMLERR_NO_ERROR )
 185     {
 186         pImp->hConv = DdeConnect( pInst->hDdeInstCli,*pService,*pTopic, NULL);
 187         if( !pImp->hConv )
 188             pImp->nStatus = DdeGetLastError( pInst->hDdeInstCli );
 189     }
 190
 191     if ( pInst->pConnections )
 192         pInst->pConnections->Insert( this );
 193 }
 194
 195 // --- DdeConnection::~DdeConnection() -----------------------------
 196
 197 DdeConnection::~DdeConnection()
 198 {
 199     if ( pImp->hConv )
 200         DdeDisconnect( pImp->hConv );
 201
 202     delete pService;
 203     delete pTopic;
 204
 205     DdeInstData* pInst = ImpGetInstData();
 206     DBG_ASSERT(pInst,"SVDDE:No instance data");
 207     if ( pInst->pConnections )
 208         pInst->pConnections->Remove( this );
 209
 210     pInst->nInstanceCli--;
 211     pInst->nRefCount--;
 212     if ( !pInst->nInstanceCli && pInst->hDdeInstCli )
 213     {
 214         if( DdeUninitialize( pInst->hDdeInstCli ) )
 215         {
 216             pInst->hDdeInstCli = NULL;
 217             delete pInst->pConnections;
 218             pInst->pConnections = NULL;
 219             if( pInst->nRefCount == 0 )
 220                 ImpDeinitInstData();
 221         }
 222     }
 223     delete pImp;
 224 }
 225
 226 // --- DdeConnection::IsConnected() --------------------------------
 227
 228 BOOL DdeConnection::IsConnected()
 229 {
 230     CONVINFO c;
 231 #ifdef OS2
 232     c.nSize = sizeof( c );
 233 #else
 234     c.cb = sizeof( c );
 235 #endif
 236     if ( DdeQueryConvInfo( pImp->hConv, QID_SYNC, &c ) )
 237         return TRUE;
 238     else
 239     {
 240         DdeInstData* pInst = ImpGetInstData();
 241         pImp->hConv = DdeReconnect( pImp->hConv );
 242         pImp->nStatus = pImp->hConv ? DMLERR_NO_ERROR : DdeGetLastError( pInst->hDdeInstCli );
 243         return BOOL( pImp->nStatus == DMLERR_NO_ERROR );
 244     }
 245 }
 246
 247 // --- DdeConnection::GetServiceName() -----------------------------
 248
 249 const String& DdeConnection::GetServiceName()
 250 {
 251     return (const String&)*pService;
 252 }
 253
 254 // --- DdeConnection::GetTopicName() -------------------------------
 255
 256 const String& DdeConnection::GetTopicName()
 257 {
 258     return (const String&)*pTopic;
 259 }
 260
 261 // --- DdeConnection::GetConvId() ----------------------------------
 262
 263 long DdeConnection::GetConvId()
 264 {
 265     return (long)pImp->hConv;
 266 }
 267
 268 const DdeConnections& DdeConnection::GetConnections()
 269 {
 270     DdeInstData* pInst = ImpGetInstData();
 271     DBG_ASSERT(pInst,"SVDDE:No instance data");
 272     return *(pInst->pConnections);
 273 }
 274
 275 // --- DdeTransaction::DdeTransaction() ----------------------------
 276
 277 DdeTransaction::DdeTransaction( DdeConnection& d, const String& rItemName,
 278                                 long n ) :
 279                     rDde( d )
 280 {
 281     DdeInstData* pInst = ImpGetInstData();
 282     pName = new DdeString( pInst->hDdeInstCli, rItemName );
 283     nTime = n;
 284     nId   = 0;
 285     nType = 0;
 286     bBusy = FALSE;
 287
 288     rDde.aTransactions.Insert( this );
 289 }
 290
 291 // --- DdeTransaction::~DdeTransaction() ---------------------------
 292
 293 DdeTransaction::~DdeTransaction()
 294 {
 295     if ( nId && rDde.pImp->hConv )
 296     {
 297         DdeInstData* pInst = ImpGetInstData();
 298         DdeAbandonTransaction( pInst->hDdeInstCli, rDde.pImp->hConv, nId );
 299     }
 300
 301     delete pName;
 302     rDde.aTransactions.Remove( this );
 303 }
 304
 305 // --- DdeTransaction::Execute() -----------------------------------
 306
 307 void DdeTransaction::Execute()
 308 {
 309     HSZ     hItem = *pName;
 310     void*   pData = (void*)(const void *)aDdeData;
 311     DWORD   nData = (DWORD)(long)aDdeData;
 312     ULONG       nIntFmt = aDdeData.pImp->nFmt;
 313     UINT    nExtFmt  = DdeData::GetExternalFormat( nIntFmt );
 314     DdeInstData* pInst = ImpGetInstData();
 315
 316     if ( nType == XTYP_EXECUTE )
 317         hItem = NULL;
 318     if ( nType != XTYP_EXECUTE && nType != XTYP_POKE )
 319     {
 320         pData = NULL;
 321         nData = 0L;
 322     }
 323     if ( nTime )
 324     {
 325         HDDEDATA hData = DdeClientTransaction( (unsigned char*)pData,
 326                                                nData, rDde.pImp->hConv,
 327                                                hItem, nExtFmt, (UINT)nType,
 328                                                (DWORD)nTime, (DWORD FAR*)NULL );
 329
 330         rDde.pImp->nStatus = DdeGetLastError( pInst->hDdeInstCli );
 331         if( hData && nType == XTYP_REQUEST )
 332         {
 333             {
 334                 DdeData d;
 335                 d.pImp->hData = hData;
 336                 d.pImp->nFmt = nIntFmt;
 337                 d.Lock();
 338                 Data( &d );
 339             }
 340             DdeFreeDataHandle( hData );
 341         }
 342     }
 343     else
 344     {
 345         if ( nId && rDde.pImp->hConv )
 346             DdeAbandonTransaction( pInst->hDdeInstCli, rDde.pImp->hConv, nId);
 347         nId = 0;
 348         bBusy = TRUE;
 349         HDDEDATA hRet = DdeClientTransaction( (unsigned char*)pData, nData,
 350                                             rDde.pImp->hConv, hItem, nExtFmt,
 351                                             (UINT)nType, TIMEOUT_ASYNC,
 352                                             (DWORD FAR *) ((long*) &nId) );
 353         rDde.pImp->nStatus = hRet ? DMLERR_NO_ERROR
 354                                   : DdeGetLastError( pInst->hDdeInstCli );
 355     }
 356 }
 357
 358 // --- DdeTransaction::GetName() -----------------------------------
 359
 360 const String& DdeTransaction::GetName() const
 361 {
 362     return *pName;
 363 }
 364
 365 // --- DdeTransaction::Data() --------------------------------------
 366
 367
 368 void __EXPORT DdeTransaction::Data( const DdeData* p )
 369 {
 370     Application::GetSolarMutex().acquire();
 371     aData.Call( (void*)p );
 372     Application::GetSolarMutex().release();
 373 }
 374
 375 // --- DdeTransaction::Done() --------------------------------------
 376
 377 void __EXPORT DdeTransaction::Done( BOOL bDataValid )
 378 {
 379     aDone.Call( (void*)bDataValid );
 380 }
 381
 382 // --- DdeLink::DdeLink() ------------------------------------------
 383
 384 DdeLink::DdeLink( DdeConnection& d, const String& aItemName, long n ) :
 385             DdeTransaction (d, aItemName, n)
 386 {
 387 }
 388
 389 // --- DdeLink::~DdeLink() -----------------------------------------
 390
 391 DdeLink::~DdeLink()
 392 {
 393     nType = (USHORT)XTYP_ADVSTOP;
 394     nTime = 0;
 395 }
 396
 397 // --- DdeLink::Notify() -----------------------------------------
 398
 399 void __EXPORT DdeLink::Notify()
 400 {
 401     aNotify.Call( NULL );
 402 }
 403
 404 // --- DdeRequest::DdeRequest() ------------------------------------
 405
 406 DdeRequest::DdeRequest( DdeConnection& d, const String& i, long n ) :
 407                 DdeTransaction( d, i, n )
 408 {
 409     nType = XTYP_REQUEST;
 410 }
 411
 412 // --- DdeWarmLink::DdeWarmLink() ----------------------------------
 413
 414 DdeWarmLink::DdeWarmLink( DdeConnection& d, const String& i, long n ) :
 415                 DdeLink( d, i, n )
 416 {
 417     nType = XTYP_ADVSTART | XTYPF_NODATA;
 418 }
 419
 420 // --- DdeHotLink::DdeHotLink() ------------------------------------
 421
 422 DdeHotLink::DdeHotLink( DdeConnection& d, const String& i, long n ) :
 423                 DdeLink( d, i, n )
 424 {
 425     nType = XTYP_ADVSTART;
 426 }
 427
 428 // --- DdePoke::DdePoke() ------------------------------------------
 429
 430 DdePoke::DdePoke( DdeConnection& d, const String& i, const char* p,
 431                   long l, ULONG f, long n ) :
 432             DdeTransaction( d, i, n )
 433 {
 434     aDdeData = DdeData( p, l, f );
 435     nType = XTYP_POKE;
 436 }
 437
 438 // --- DdePoke::DdePoke() ------------------------------------------
 439
 440 DdePoke::DdePoke( DdeConnection& d, const String& i, const String& rData,
 441                   long n ) :
 442             DdeTransaction( d, i, n )
 443 {
 444 //      ByteString aByteStr( rData, osl_getThreadTextEncoding() );
 445     aDdeData = DdeData( (void*) rData.GetBuffer(), sizeof(sal_Unicode) * (rData.Len()), CF_TEXT );
 446     nType = XTYP_POKE;
 447 }
 448
 449 // --- DdePoke::DdePoke() ------------------------------------------
 450
 451 DdePoke::DdePoke( DdeConnection& d, const String& i, const DdeData& rData,
 452                   long n ) :
 453             DdeTransaction( d, i, n )
 454 {
 455     aDdeData = rData;
 456     nType = XTYP_POKE;
 457 }
 458
 459 // --- DdeExecute::DdeExecute() ------------------------------------
 460
 461 DdeExecute::DdeExecute( DdeConnection& d, const String& rData, long n ) :
 462                 DdeTransaction( d, String(), n )
 463 {
 464 //      ByteString aByteStr( rData, osl_getThreadTextEncoding() );
 465     aDdeData = DdeData( (void*)rData.GetBuffer(), sizeof(sal_Unicode) * (rData.Len() + 1), CF_TEXT );
 466     nType = XTYP_EXECUTE;
 467 }
 468
 469 // --- DdeConnection::GetError() -----------------------------------
 470
 471 long DdeConnection::GetError()
 472 {
 473     return pImp->nStatus;
 474 }