toolkit/source/awt/vclxprinter.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: vclxprinter.cxx,v $
  10  * $Revision: 1.10 $
  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_toolkit.hxx"
  33
  34
  35 #include <toolkit/awt/vclxprinter.hxx>
  36 #include <toolkit/helper/macros.hxx>
  37 #include <cppuhelper/typeprovider.hxx>
  38 #include <rtl/memory.h>
  39 #include <rtl/uuid.h>
  40
  41
  42 #include <vcl/print.hxx>
  43 #include <vcl/jobset.hxx>
  44 #include <vcl/svapp.hxx>
  45
  46 #include <tools/debug.hxx>
  47 #include <tools/stream.hxx>
  48
  49 #include <toolkit/awt/vclxdevice.hxx>
  50
  51
  52 #define BINARYSETUPMARKER       0x23864691
  53
  54 #define PROPERTY_Orientation    0
  55 #define PROPERTY_Horizontal             1
  56
  57 ::com::sun::star::beans::Property* ImplGetProperties( sal_uInt16& rElementCount )
  58 {
  59     static ::com::sun::star::beans::Property* pProperties = NULL;
  60     static sal_uInt16 nElements = 0;
  61     if( !pProperties )
  62     {
  63         ::osl::Guard< ::osl::Mutex > aGuard( ::osl::Mutex::getGlobalMutex() );
  64         if( !pProperties )
  65         {
  66             static ::com::sun::star::beans::Property __FAR_DATA aPropTable[] =
  67             {
  68                 ::com::sun::star::beans::Property( ::rtl::OUString::createFromAscii( "Orientation" ), PROPERTY_Orientation, ::getCppuType((const sal_Int16*)0), 0 ),
  69                 ::com::sun::star::beans::Property( ::rtl::OUString::createFromAscii( "Horizontal" ), PROPERTY_Horizontal, ::getBooleanCppuType(), 0 )
  70             };
  71             pProperties = aPropTable;
  72             nElements = sizeof( aPropTable ) / sizeof( ::com::sun::star::beans::Property );
  73         }
  74     }
  75     rElementCount = nElements;
  76     return pProperties;
  77 }
  78
  79 //      ----------------------------------------------------
  80 //      class VCLXPrinterPropertySet
  81 //      ----------------------------------------------------
  82
  83 // ::com::sun::star::uno::XInterface
  84 ::com::sun::star::uno::Any VCLXPrinterPropertySet::queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException)
  85 {
  86     ::com::sun::star::uno::Any aRet = ::cppu::queryInterface( rType,
  87                                         SAL_STATIC_CAST( ::com::sun::star::beans::XMultiPropertySet*, this ),
  88                                         SAL_STATIC_CAST( ::com::sun::star::beans::XFastPropertySet*, this ),
  89                                         SAL_STATIC_CAST( ::com::sun::star::beans::XPropertySet*, (::cppu::OPropertySetHelper*) this ),
  90                                         SAL_STATIC_CAST( ::com::sun::star::awt::XPrinterPropertySet*, this ),
  91                                         SAL_STATIC_CAST( ::com::sun::star::lang::XTypeProvider*, this ) );
  92     return (aRet.hasValue() ? aRet : OPropertySetHelper::queryInterface( rType ));
  93 }
  94
  95 // ::com::sun::star::lang::XTypeProvider
  96 IMPL_XTYPEPROVIDER_START( VCLXPrinterPropertySet )
  97     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::beans::XMultiPropertySet>* ) NULL ),
  98     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::beans::XFastPropertySet>* ) NULL ),
  99     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>* ) NULL ),
 100     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::awt::XPrinterPropertySet>* ) NULL )
 101 IMPL_XTYPEPROVIDER_END
 102
 103 VCLXPrinterPropertySet::VCLXPrinterPropertySet( const String& rPrinterName )
 104     : OPropertySetHelper( BrdcstHelper )
 105 {
 106     osl::Guard< vos::IMutex > aSolarGuard( Application::GetSolarMutex() );
 107
 108     mpPrinter = new Printer( rPrinterName );
 109     mnOrientation = 0;
 110     mbHorizontal = sal_False;
 111 }
 112
 113 VCLXPrinterPropertySet::~VCLXPrinterPropertySet()
 114 {
 115     osl::Guard< vos::IMutex > aSolarGuard( Application::GetSolarMutex() );
 116
 117      delete mpPrinter;
 118 }
 119
 120 ::com::sun::star::uno::Reference< ::com::sun::star::awt::XDevice >  VCLXPrinterPropertySet::GetDevice()
 121 {
 122     if ( !mxPrnDevice.is() )
 123     {
 124         VCLXDevice* pDev = new VCLXDevice;
 125         pDev->SetOutputDevice( GetPrinter() );
 126         mxPrnDevice = pDev;
 127     }
 128     return mxPrnDevice;
 129 }
 130
 131 ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > VCLXPrinterPropertySet::getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException)
 132 {
 133     static ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >  xInfo( createPropertySetInfo( getInfoHelper() ) );
 134     return xInfo;
 135 }
 136
 137 ::cppu::IPropertyArrayHelper& VCLXPrinterPropertySet::getInfoHelper()
 138 {
 139     static ::cppu::OPropertyArrayHelper* pPropertyArrayHelper = NULL;
 140     if ( !pPropertyArrayHelper )
 141     {
 142         ::osl::Guard< ::osl::Mutex > aGuard( ::osl::Mutex::getGlobalMutex() );
 143         if( !pPropertyArrayHelper )
 144         {
 145             sal_uInt16 nElements;
 146             ::com::sun::star::beans::Property* pProps = ImplGetProperties( nElements );
 147             pPropertyArrayHelper = new ::cppu::OPropertyArrayHelper( pProps, nElements, sal_False );
 148         }
 149     }
 150     return *pPropertyArrayHelper ;
 151 }
 152
 153 sal_Bool VCLXPrinterPropertySet::convertFastPropertyValue( ::com::sun::star::uno::Any & rConvertedValue, ::com::sun::star::uno::Any & rOldValue, sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue ) throw (::com::sun::star::lang::IllegalArgumentException)
 154 {
 155     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 156
 157     sal_Bool bDifferent = sal_False;
 158     switch ( nHandle )
 159     {
 160         case PROPERTY_Orientation:
 161         {
 162             sal_Int16 n;
 163             if( ( rValue >>= n ) && ( n != mnOrientation ) )
 164             {
 165                 rConvertedValue <<= n;
 166                 rOldValue <<= mnOrientation;
 167                 bDifferent = sal_True;
 168             }
 169         }
 170         break;
 171         case PROPERTY_Horizontal:
 172         {
 173             sal_Bool b;
 174             if( ( rValue >>= b ) && ( b != mbHorizontal ) )
 175             {
 176                 rConvertedValue <<= b;
 177                 rOldValue <<= mbHorizontal;
 178                 bDifferent = sal_True;
 179             }
 180         }
 181         break;
 182         default:
 183         {
 184             DBG_ERROR( "VCLXPrinterPropertySet_Impl::convertFastPropertyValue - invalid Handle" );
 185         }
 186     }
 187     return bDifferent;
 188 }
 189
 190 void VCLXPrinterPropertySet::setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue ) throw (::com::sun::star::uno::Exception)
 191 {
 192     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 193
 194     switch( nHandle )
 195     {
 196         case PROPERTY_Orientation:
 197         {
 198             rValue >>= mnOrientation;
 199         }
 200         break;
 201         case PROPERTY_Horizontal:
 202         {
 203             rValue >>= mbHorizontal;
 204         }
 205         break;
 206         default:
 207         {
 208             DBG_ERROR( "VCLXPrinterPropertySet_Impl::convertFastPropertyValue - invalid Handle" );
 209         }
 210     }
 211 }
 212
 213 void VCLXPrinterPropertySet::getFastPropertyValue( ::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const
 214 {
 215     ::osl::Guard< ::osl::Mutex > aGuard( ((VCLXPrinterPropertySet*)this)->Mutex );
 216
 217     switch( nHandle )
 218     {
 219         case PROPERTY_Orientation:
 220             rValue <<= mnOrientation;
 221         break;
 222         case PROPERTY_Horizontal:
 223             rValue <<= mbHorizontal;
 224         break;
 225         default:
 226         {
 227             DBG_ERROR( "VCLXPrinterPropertySet_Impl::convertFastPropertyValue - invalid Handle" );
 228         }
 229     }
 230 }
 231
 232 // ::com::sun::star::awt::XPrinterPropertySet
 233 void VCLXPrinterPropertySet::setHorizontal( sal_Bool bHorizontal ) throw(::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException)
 234 {
 235     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 236
 237     ::com::sun::star::uno::Any aValue;
 238     aValue <<= bHorizontal;
 239     setFastPropertyValue( PROPERTY_Horizontal, aValue );
 240 }
 241
 242 ::com::sun::star::uno::Sequence< ::rtl::OUString > VCLXPrinterPropertySet::getFormDescriptions(  ) throw(::com::sun::star::uno::RuntimeException)
 243 {
 244     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 245
 246     sal_uInt16 nPaperBinCount = GetPrinter()->GetPaperBinCount();
 247     ::com::sun::star::uno::Sequence< ::rtl::OUString >  aDescriptions( nPaperBinCount );
 248     for ( sal_uInt16 n = 0; n < nPaperBinCount; n++ )
 249     {
 250         // Format: <DisplayFormName;FormNameId;DisplayPaperBinName;PaperBinNameId;DisplayPaperName;PaperNameId>
 251         String aDescr( RTL_CONSTASCII_USTRINGPARAM( "*;*;" ) );
 252         aDescr += GetPrinter()->GetPaperBinName( n );
 253         aDescr += ';';
 254         aDescr += n;
 255         aDescr.AppendAscii( ";*;*", 4 );
 256
 257         aDescriptions.getArray()[n] = aDescr;
 258     }
 259     return aDescriptions;
 260 }
 261
 262 void VCLXPrinterPropertySet::selectForm( const ::rtl::OUString& rFormDescription ) throw(::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException)
 263 {
 264     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 265
 266     sal_Int32 nIndex = 0;
 267     sal_uInt16 nPaperBin = sal::static_int_cast< sal_uInt16 >(
 268         rFormDescription.getToken( 3, ';', nIndex ).toInt32());
 269     GetPrinter()->SetPaperBin( nPaperBin );
 270 }
 271
 272 ::com::sun::star::uno::Sequence< sal_Int8 > VCLXPrinterPropertySet::getBinarySetup(  ) throw(::com::sun::star::uno::RuntimeException)
 273 {
 274     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 275
 276     SvMemoryStream aMem;
 277     aMem << BINARYSETUPMARKER;
 278     aMem << GetPrinter()->GetJobSetup();
 279     return ::com::sun::star::uno::Sequence<sal_Int8>( (sal_Int8*) aMem.GetData(), aMem.Tell() );
 280 }
 281
 282 void VCLXPrinterPropertySet::setBinarySetup( const ::com::sun::star::uno::Sequence< sal_Int8 >& data ) throw(::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException)
 283 {
 284     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 285
 286     SvMemoryStream aMem( (char*) data.getConstArray(), data.getLength(), STREAM_READ );
 287     sal_uInt32 nMarker;
 288     aMem >> nMarker;
 289     DBG_ASSERT( nMarker == BINARYSETUPMARKER, "setBinarySetup - invalid!" );
 290     if ( nMarker == BINARYSETUPMARKER )
 291     {
 292         JobSetup aSetup;
 293         aMem >> aSetup;
 294         GetPrinter()->SetJobSetup( aSetup );
 295     }
 296 }
 297
 298
 299 //      ----------------------------------------------------
 300 //      class VCLXPrinter
 301 //      ----------------------------------------------------
 302 VCLXPrinter::VCLXPrinter( const String& rPrinterName )
 303     : VCLXPrinterPropertySet( rPrinterName )
 304 {
 305 }
 306
 307 VCLXPrinter::~VCLXPrinter()
 308 {
 309 }
 310
 311 // ::com::sun::star::uno::XInterface
 312 ::com::sun::star::uno::Any VCLXPrinter::queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException)
 313 {
 314     ::com::sun::star::uno::Any aRet = ::cppu::queryInterface( rType,
 315                                         SAL_STATIC_CAST( ::com::sun::star::awt::XPrinter*, this ) );
 316
 317     if ( !aRet.hasValue() )
 318         aRet = VCLXPrinterPropertySet::queryInterface( rType );
 319
 320     return (aRet.hasValue() ? aRet : OWeakObject::queryInterface( rType ));
 321 }
 322
 323 // ::com::sun::star::lang::XTypeProvider
 324 IMPL_XTYPEPROVIDER_START( VCLXPrinter )
 325     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::awt::XPrinter>* ) NULL ),
 326     VCLXPrinterPropertySet::getTypes()
 327 IMPL_XTYPEPROVIDER_END
 328
 329 sal_Bool VCLXPrinter::start( const ::rtl::OUString& rJobName, sal_Int16 /*nCopies*/, sal_Bool /*bCollate*/ ) throw(::com::sun::star::awt::PrinterException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException)
 330 {
 331     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 332
 333     sal_Bool bDone = sal_True;
 334     if ( GetPrinter() )
 335         bDone = GetPrinter()->StartJob( rJobName );
 336
 337     return bDone;
 338 }
 339
 340 void VCLXPrinter::end(  ) throw(::com::sun::star::awt::PrinterException, ::com::sun::star::uno::RuntimeException)
 341 {
 342     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 343
 344     if ( GetPrinter() )
 345         GetPrinter()->EndJob();
 346 }
 347
 348 void VCLXPrinter::terminate(  ) throw(::com::sun::star::uno::RuntimeException)
 349 {
 350     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 351
 352     if ( GetPrinter() )
 353         GetPrinter()->AbortJob();
 354 }
 355
 356 ::com::sun::star::uno::Reference< ::com::sun::star::awt::XDevice > VCLXPrinter::startPage(  ) throw(::com::sun::star::awt::PrinterException, ::com::sun::star::uno::RuntimeException)
 357 {
 358     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 359
 360     if ( GetPrinter() )
 361         GetPrinter()->StartPage();
 362     return GetDevice();
 363 }
 364
 365 void VCLXPrinter::endPage(  ) throw(::com::sun::star::awt::PrinterException, ::com::sun::star::uno::RuntimeException)
 366 {
 367     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 368
 369     if ( GetPrinter() )
 370         GetPrinter()->EndPage();
 371 }
 372
 373
 374 //      ----------------------------------------------------
 375 //      class VCLXInfoPrinter
 376 //      ----------------------------------------------------
 377
 378 VCLXInfoPrinter::VCLXInfoPrinter( const String& rPrinterName )
 379     : VCLXPrinterPropertySet( rPrinterName )
 380 {
 381 }
 382
 383 VCLXInfoPrinter::~VCLXInfoPrinter()
 384 {
 385 }
 386
 387 // ::com::sun::star::uno::XInterface
 388 ::com::sun::star::uno::Any VCLXInfoPrinter::queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException)
 389 {
 390     ::com::sun::star::uno::Any aRet = ::cppu::queryInterface( rType,
 391                                         SAL_STATIC_CAST( ::com::sun::star::awt::XInfoPrinter*, this ) );
 392
 393     if ( !aRet.hasValue() )
 394         aRet = VCLXPrinterPropertySet::queryInterface( rType );
 395
 396     return (aRet.hasValue() ? aRet : OWeakObject::queryInterface( rType ));
 397 }
 398
 399 // ::com::sun::star::lang::XTypeProvider
 400 IMPL_XTYPEPROVIDER_START( VCLXInfoPrinter )
 401     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::awt::XInfoPrinter>* ) NULL ),
 402     VCLXPrinterPropertySet::getTypes()
 403 IMPL_XTYPEPROVIDER_END
 404
 405 // ::com::sun::star::awt::XInfoPrinter
 406 ::com::sun::star::uno::Reference< ::com::sun::star::awt::XDevice > VCLXInfoPrinter::createDevice(  ) throw(::com::sun::star::uno::RuntimeException)
 407 {
 408     ::osl::Guard< ::osl::Mutex > aGuard( Mutex );
 409
 410     return GetDevice();
 411 }
 412
 413 //      ----------------------------------------------------
 414 //      class VCLXPrinterServer
 415 //      ----------------------------------------------------
 416
 417 // ::com::sun::star::uno::XInterface
 418 ::com::sun::star::uno::Any VCLXPrinterServer::queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException)
 419 {
 420     ::com::sun::star::uno::Any aRet = ::cppu::queryInterface( rType,
 421                                         SAL_STATIC_CAST( ::com::sun::star::awt::XPrinterServer*, this ) );
 422     return (aRet.hasValue() ? aRet : OWeakObject::queryInterface( rType ));
 423 }
 424
 425 // ::com::sun::star::lang::XTypeProvider
 426 IMPL_XTYPEPROVIDER_START( VCLXPrinterServer )
 427     getCppuType( ( ::com::sun::star::uno::Reference< ::com::sun::star::awt::XPrinterServer>* ) NULL )
 428 IMPL_XTYPEPROVIDER_END
 429
 430 // ::com::sun::star::awt::XPrinterServer
 431 ::com::sun::star::uno::Sequence< ::rtl::OUString > VCLXPrinterServer::getPrinterNames(  ) throw(::com::sun::star::uno::RuntimeException)
 432 {
 433     const std::vector<rtl::OUString>& rQueues = Printer::GetPrinterQueues();
 434     sal_uInt32 nPrinters = rQueues.size();
 435
 436     ::com::sun::star::uno::Sequence< ::rtl::OUString >  aNames( nPrinters );
 437     for ( sal_uInt32 n = 0; n < nPrinters; n++ )
 438         aNames.getArray()[n] = rQueues[n];
 439
 440     return aNames;
 441 }
 442
 443 ::com::sun::star::uno::Reference< ::com::sun::star::awt::XPrinter > VCLXPrinterServer::createPrinter( const ::rtl::OUString& rPrinterName ) throw(::com::sun::star::uno::RuntimeException)
 444 {
 445     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XPrinter > xP;
 446     xP = new VCLXPrinter( rPrinterName );
 447     return xP;
 448 }
 449
 450 ::com::sun::star::uno::Reference< ::com::sun::star::awt::XInfoPrinter > VCLXPrinterServer::createInfoPrinter( const ::rtl::OUString& rPrinterName ) throw(::com::sun::star::uno::RuntimeException)
 451 {
 452     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XInfoPrinter > xP;
 453     xP = new VCLXInfoPrinter( rPrinterName );
 454     return xP;
 455 }
 456
 457
 458