extensions/source/scanner/twain.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: twain.cxx,v $
  10  * $Revision: 1.6 $
  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_extensions.hxx"
  33
  34 #include <string.h>
  35 #include <math.h>
  36
  37 #if defined( WNT ) || defined (WIN)
  38 #include <tools/svwin.h>
  39 #endif
  40 #ifdef OS2
  41 #include <svpm.h>
  42 #endif // OS2
  43 #include <vos/module.hxx>
  44 #include <tools/stream.hxx>
  45 #include <vcl/svapp.hxx>
  46 #include <vcl/wrkwin.hxx>
  47 #include <vcl/sysdata.hxx>
  48 #include "twain.hxx"
  49
  50 // -----------
  51 // - Defines -
  52 // -----------
  53
  54 #define PFUNC                                           (*pDSM)
  55 #define FIXTODOUBLE( nFix )             ((double)nFix.Whole+(double)nFix.Frac/65536.)
  56 #define FIXTOLONG( nFix )                       ((long)floor(FIXTODOUBLE(nFix)+0.5))
  57
  58 #if defined WIN
  59 #define TWAIN_LIBNAME                           "TWAIN.DLL"
  60 #define TWAIN_FUNCNAME                          "DSM_Entry"
  61 #elif defined WNT
  62 #define TWAIN_LIBNAME                           "TWAIN_32.DLL"
  63 #define TWAIN_FUNCNAME                          "DSM_Entry"
  64 #elif defined OS2
  65 #define TWAIN_LIBNAME                           "twain"
  66 #define TWAIN_FUNCNAME                          "DSM_ENTRY"
  67 #endif
  68
  69 // -----------
  70 // - Statics -
  71 // -----------
  72
  73 static ImpTwain* pImpTwainInstance = NULL;
  74
  75 // ---------
  76 // - Procs -
  77 // ---------
  78
  79 #ifdef OS2
  80
  81     #define PTWAINMSG QMSG*
  82
  83     MRESULT EXPENTRY TwainWndProc( HWND hWnd, ULONG nMsg, MPARAM nParam1, MPARAM nParam2 )
  84     {
  85         return (MRESULT) TRUE;
  86     }
  87
  88
  89 #else // OS2
  90
  91     #define PTWAINMSG MSG*
  92
  93     // -------------------------------------------------------------------------
  94
  95     LRESULT CALLBACK TwainWndProc( HWND hWnd,UINT nMsg, WPARAM nPar1, LPARAM nPar2 )
  96     {
  97         return DefWindowProc( hWnd, nMsg, nPar1, nPar2 );
  98     }
  99
 100     // -------------------------------------------------------------------------
 101
 102     LRESULT CALLBACK TwainMsgProc( int nCode, WPARAM wParam, LPARAM lParam )
 103     {
 104         MSG* pMsg = (MSG*) lParam;
 105
 106         if( ( nCode < 0 ) ||
 107             ( pImpTwainInstance->hTwainWnd != pMsg->hwnd ) ||
 108             !pImpTwainInstance->ImplHandleMsg( (void*) lParam ) )
 109         {
 110             return CallNextHookEx( pImpTwainInstance->hTwainHook, nCode, wParam, lParam );
 111         }
 112         else
 113         {
 114             pMsg->message = WM_USER;
 115             pMsg->lParam = 0;
 116
 117             return 0;
 118         }
 119     }
 120
 121 #endif // OS2
 122
 123 // ------------
 124 // - ImpTwain -
 125 // ------------
 126
 127 ImpTwain::ImpTwain( const Link& rNotifyLink ) :
 128             aNotifyLink ( rNotifyLink ),
 129             pDSM                ( NULL ),
 130             pMod                ( NULL ),
 131             hTwainWnd   ( 0 ),
 132             hTwainHook  ( 0 ),
 133             nCurState   ( 1 )
 134 {
 135     pImpTwainInstance = this;
 136
 137     aAppIdent.Id = 0;
 138     aAppIdent.Version.MajorNum = 1;
 139     aAppIdent.Version.MinorNum = 0;
 140     aAppIdent.Version.Language = TWLG_USA;
 141     aAppIdent.Version.Country = TWCY_USA;
 142     aAppIdent.ProtocolMajor = TWON_PROTOCOLMAJOR;
 143     aAppIdent.ProtocolMinor = TWON_PROTOCOLMINOR;
 144     aAppIdent.SupportedGroups = DG_IMAGE | DG_CONTROL;
 145     strcpy( aAppIdent.Version.Info, "6.0" );
 146     strcpy( aAppIdent.Manufacturer, "Sun Microsystems");
 147     strcpy( aAppIdent.ProductFamily,"Office");
 148     strcpy( aAppIdent.ProductName, "Office");
 149
 150 #ifdef OS2
 151
 152     hAB = Sysdepen::GethAB();
 153     ImplFallback( TWAIN_EVENT_QUIT );
 154     // hTwainWnd = WinCreateWindow( HWND_DESKTOP, WC_FRAME, "dummy", 0, 0, 0, 0, 0, HWND_DESKTOP, HWND_BOTTOM, 0, 0, 0 );
 155
 156 #else
 157
 158     HWND                hParentWnd = HWND_DESKTOP;
 159     WNDCLASS    aWc = { 0, &TwainWndProc, 0, sizeof( WNDCLASS ), GetModuleHandle( NULL ),
 160                         NULL, NULL, NULL, NULL, "TwainClass" };
 161
 162     RegisterClass( &aWc );
 163     hTwainWnd = CreateWindowEx( WS_EX_TOPMOST, aWc.lpszClassName, "TWAIN", 0, 0, 0, 0, 0, hParentWnd, NULL, aWc.hInstance, 0 );
 164     hTwainHook = SetWindowsHookEx( WH_GETMESSAGE, &TwainMsgProc, NULL, GetCurrentThreadId() );
 165
 166 #endif
 167 }
 168
 169 // -----------------------------------------------------------------------------
 170
 171 ImpTwain::~ImpTwain()
 172 {
 173 }
 174
 175 // -----------------------------------------------------------------------------
 176
 177 void ImpTwain::Destroy()
 178 {
 179     ImplFallback( TWAIN_EVENT_NONE );
 180     Application::PostUserEvent( LINK( this, ImpTwain, ImplDestroyHdl ), NULL );
 181 }
 182
 183 // -----------------------------------------------------------------------------
 184
 185 BOOL ImpTwain::SelectSource()
 186 {
 187     TW_UINT16 nRet = TWRC_FAILURE;
 188
 189     if( !!aBitmap )
 190         aBitmap = Bitmap();
 191
 192     ImplOpenSourceManager();
 193
 194     if( 3 == nCurState )
 195     {
 196         TW_IDENTITY aIdent;
 197
 198         aIdent.Id = 0, aIdent.ProductName[ 0 ] = '\0';
 199         aNotifyLink.Call( (void*) TWAIN_EVENT_SCANNING );
 200         nRet = PFUNC( &aAppIdent, NULL, DG_CONTROL, DAT_IDENTITY, MSG_USERSELECT, &aIdent );
 201     }
 202
 203     ImplFallback( TWAIN_EVENT_QUIT );
 204
 205     return( nRet == TWRC_SUCCESS || nRet == TWRC_CANCEL );
 206 }
 207
 208 // -----------------------------------------------------------------------------
 209
 210 BOOL ImpTwain::InitXfer()
 211 {
 212     BOOL bRet = FALSE;
 213
 214     if( !!aBitmap )
 215         aBitmap = Bitmap();
 216
 217     ImplOpenSourceManager();
 218
 219     if( 3 == nCurState )
 220     {
 221         ImplOpenSource();
 222
 223         if( 4 == nCurState )
 224             bRet = ImplEnableSource();
 225     }
 226
 227     if( !bRet )
 228         ImplFallback( TWAIN_EVENT_QUIT );
 229
 230     return bRet;
 231 }
 232
 233 // -----------------------------------------------------------------------------
 234
 235 Bitmap ImpTwain::GetXferBitmap()
 236 {
 237     Bitmap aRet( aBitmap );
 238     aBitmap = Bitmap();
 239     return aRet;
 240 }
 241
 242 // -----------------------------------------------------------------------------
 243
 244 void ImpTwain::ImplOpenSourceManager()
 245 {
 246     if( 1 == nCurState )
 247     {
 248         pMod = new NAMESPACE_VOS( OModule )();
 249
 250         if( pMod->load( TWAIN_LIBNAME ) )
 251         {
 252             nCurState = 2;
 253
 254             if( ( ( pDSM = (DSMENTRYPROC) pMod->getSymbol( TWAIN_FUNCNAME ) ) != NULL ) &&
 255                 ( PFUNC( &aAppIdent, NULL, DG_CONTROL, DAT_PARENT, MSG_OPENDSM, &hTwainWnd ) == TWRC_SUCCESS ) )
 256             {
 257                 nCurState = 3;
 258             }
 259         }
 260         else
 261         {
 262             delete pMod;
 263             pMod = NULL;
 264         }
 265     }
 266 }
 267
 268 // -----------------------------------------------------------------------------
 269
 270 void ImpTwain::ImplOpenSource()
 271 {
 272     if( 3 == nCurState )
 273     {
 274         if( ( PFUNC( &aAppIdent, NULL, DG_CONTROL, DAT_IDENTITY, MSG_GETDEFAULT, &aSrcIdent ) == TWRC_SUCCESS ) &&
 275             ( PFUNC( &aAppIdent, NULL, DG_CONTROL, DAT_IDENTITY, MSG_OPENDS, &aSrcIdent ) == TWRC_SUCCESS ) )
 276         {
 277 #ifdef OS2
 278
 279             // negotiate capabilities
 280
 281 #else
 282
 283             TW_CAPABILITY       aCap = { CAP_XFERCOUNT, TWON_ONEVALUE, GlobalAlloc( GHND, sizeof( TW_ONEVALUE ) ) };
 284             TW_ONEVALUE*        pVal = (TW_ONEVALUE*) GlobalLock( aCap.hContainer );
 285
 286             pVal->ItemType = TWTY_INT16, pVal->Item = 1;
 287             GlobalUnlock( aCap.hContainer );
 288             PFUNC( &aAppIdent, &aSrcIdent, DG_CONTROL, DAT_CAPABILITY, MSG_SET, &aCap );
 289             GlobalFree( aCap.hContainer );
 290 #endif
 291
 292             nCurState = 4;
 293         }
 294     }
 295 }
 296
 297 // -----------------------------------------------------------------------------
 298
 299 BOOL ImpTwain::ImplEnableSource()
 300 {
 301     BOOL bRet = FALSE;
 302
 303     if( 4 == nCurState )
 304     {
 305         TW_USERINTERFACE aUI = { TRUE, TRUE, hTwainWnd };
 306
 307         aNotifyLink.Call( (void*) TWAIN_EVENT_SCANNING );
 308         nCurState = 5;
 309
 310         if( PFUNC( &aAppIdent, &aSrcIdent, DG_CONTROL, DAT_USERINTERFACE, MSG_ENABLEDS, &aUI ) == TWRC_SUCCESS )
 311             bRet = TRUE;
 312         else
 313             nCurState = 4;
 314     }
 315
 316     return bRet;
 317 }
 318
 319 // -----------------------------------------------------------------------------
 320
 321 BOOL ImpTwain::ImplHandleMsg( void* pMsg )
 322 {
 323     TW_UINT16   nRet;
 324     PTWAINMSG   pMess = (PTWAINMSG) pMsg;
 325     TW_EVENT    aEvt = { pMess, MSG_NULL };
 326
 327     nRet = PFUNC( &aAppIdent, &aSrcIdent, DG_CONTROL, DAT_EVENT, MSG_PROCESSEVENT, &aEvt );
 328
 329     if( aEvt.TWMessage != MSG_NULL )
 330     {
 331         switch( aEvt.TWMessage )
 332         {
 333             case MSG_XFERREADY:
 334             {
 335                 ULONG nEvent = TWAIN_EVENT_QUIT;
 336
 337                 if( 5 == nCurState )
 338                 {
 339                     nCurState = 6;
 340                     ImplXfer();
 341
 342                     if( !!aBitmap )
 343                         nEvent = TWAIN_EVENT_XFER;
 344                 }
 345
 346                 ImplFallback( nEvent );
 347             }
 348             break;
 349
 350             case MSG_CLOSEDSREQ:
 351                 ImplFallback( TWAIN_EVENT_QUIT );
 352             break;
 353
 354             default:
 355             break;
 356         }
 357     }
 358     else
 359         nRet = TWRC_NOTDSEVENT;
 360
 361     return( TWRC_DSEVENT == nRet );
 362 }
 363
 364 // -----------------------------------------------------------------------------
 365
 366 void ImpTwain::ImplXfer()
 367 {
 368     if( nCurState == 6 )
 369     {
 370         TW_IMAGEINFO    aInfo;
 371         TW_UINT32               hDIB = 0;
 372         long                    nWidth = aInfo.ImageWidth;
 373         long                    nHeight = aInfo.ImageLength;
 374         long                    nXRes = FIXTOLONG( aInfo.XResolution );
 375         long                    nYRes = FIXTOLONG( aInfo.YResolution );
 376
 377         if( PFUNC( &aAppIdent, &aSrcIdent, DG_IMAGE, DAT_IMAGEINFO, MSG_GET, &aInfo ) == TWRC_SUCCESS )
 378         {
 379             nWidth = aInfo.ImageWidth;
 380             nHeight = aInfo.ImageLength;
 381             nXRes = FIXTOLONG( aInfo.XResolution );
 382             nYRes = FIXTOLONG( aInfo.YResolution );
 383         }
 384         else
 385             nWidth = nHeight = nXRes = nYRes = -1L;
 386
 387         switch( PFUNC( &aAppIdent, &aSrcIdent, DG_IMAGE, DAT_IMAGENATIVEXFER, MSG_GET, &hDIB ) )
 388         {
 389             case( TWRC_CANCEL ):
 390                 nCurState = 7;
 391             break;
 392
 393             case( TWRC_XFERDONE ):
 394             {
 395 #ifdef OS2
 396
 397                 // get OS/2-Bitmap
 398
 399 #else // OS2
 400                 const ULONG nSize = GlobalSize( (HGLOBAL) hDIB );
 401                 char*           pBuf = (char*) GlobalLock( (HGLOBAL) hDIB );
 402
 403                 if( pBuf )
 404                 {
 405                     SvMemoryStream aMemStm;
 406                     aMemStm.SetBuffer( pBuf, nSize, FALSE, nSize );
 407                     aBitmap.Read( aMemStm, FALSE );
 408                     GlobalUnlock( (HGLOBAL) hDIB );
 409                 }
 410
 411                 GlobalFree( (HGLOBAL) hDIB );
 412 #endif // OS2
 413
 414                 // set resolution of bitmap if neccessary
 415                 if ( ( nXRes != -1 ) && ( nYRes != - 1 ) && ( nWidth != - 1 ) && ( nHeight != - 1 ) )
 416                 {
 417                     const MapMode aMapMode( MAP_100TH_INCH, Point(), Fraction( 100, nXRes ), Fraction( 100, nYRes ) );
 418                     aBitmap.SetPrefMapMode( aMapMode );
 419                     aBitmap.SetPrefSize( Size( nWidth, nHeight ) );
 420                 }
 421
 422                 nCurState = 7;
 423             }
 424             break;
 425
 426             default:
 427             break;
 428         }
 429     }
 430 }
 431
 432 // -----------------------------------------------------------------------------
 433
 434 void ImpTwain::ImplFallback( ULONG nEvent )
 435 {
 436     Application::PostUserEvent( LINK( this, ImpTwain, ImplFallbackHdl ), (void*) nEvent );
 437 }
 438
 439 // -----------------------------------------------------------------------------
 440
 441 IMPL_LINK( ImpTwain, ImplFallbackHdl, void*, pData )
 442 {
 443     const ULONG nEvent = (ULONG) pData;
 444     BOOL                bFallback = TRUE;
 445
 446     switch( nCurState )
 447     {
 448         case( 7 ):
 449         case( 6 ):
 450         {
 451             TW_PENDINGXFERS aXfers;
 452
 453             if( PFUNC( &aAppIdent, &aSrcIdent, DG_CONTROL, DAT_PENDINGXFERS, MSG_ENDXFER, &aXfers ) == TWRC_SUCCESS )
 454             {
 455                 if( aXfers.Count != 0 )
 456                     PFUNC( &aAppIdent, &aSrcIdent, DG_CONTROL, DAT_PENDINGXFERS, MSG_RESET, &aXfers );
 457             }
 458
 459             nCurState = 5;
 460         }
 461         break;
 462
 463         case( 5 ):
 464         {
 465             TW_USERINTERFACE aUI = { TRUE, TRUE, hTwainWnd };
 466
 467             PFUNC( &aAppIdent, &aSrcIdent, DG_CONTROL, DAT_USERINTERFACE, MSG_DISABLEDS, &aUI );
 468             nCurState = 4;
 469         }
 470         break;
 471
 472         case( 4 ):
 473         {
 474             PFUNC( &aAppIdent, NULL, DG_CONTROL, DAT_IDENTITY, MSG_CLOSEDS, &aSrcIdent );
 475             nCurState = 3;
 476         }
 477         break;
 478
 479         case( 3 ):
 480         {
 481             PFUNC( &aAppIdent, NULL, DG_CONTROL, DAT_PARENT, MSG_CLOSEDSM, &hTwainWnd );
 482             nCurState = 2;
 483         }
 484         break;
 485
 486         case( 2 ):
 487         {
 488             delete pMod;
 489             pMod = NULL;
 490             nCurState = 1;
 491         }
 492         break;
 493
 494         default:
 495         {
 496             if( nEvent != TWAIN_EVENT_NONE )
 497                 aNotifyLink.Call( (void*) nEvent );
 498
 499             bFallback = FALSE;
 500         }
 501         break;
 502     }
 503
 504     if( bFallback )
 505         ImplFallback( nEvent );
 506
 507     return 0L;
 508 }
 509
 510 // -----------------------------------------------------------------------------
 511
 512 IMPL_LINK( ImpTwain, ImplDestroyHdl, void*, p )
 513 {
 514 #ifdef OS2
 515
 516     if( hWndTwain )
 517         WinDestroyWindow( hWndTwain );
 518
 519     // unset hook
 520
 521 #else
 522
 523     if( hTwainWnd )
 524         DestroyWindow( hTwainWnd );
 525
 526     if( hTwainHook )
 527         UnhookWindowsHookEx( hTwainHook );
 528
 529 #endif
 530
 531     delete this;
 532     pImpTwainInstance = NULL;
 533
 534     return 0L;
 535 }