svtools/source/notify/cancel.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: cancel.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 #define _SFX_CANCEL_CXX
  34 #include <svtools/cancel.hxx>
  35
  36 #include <vos/mutex.hxx>
  37 #include <tools/debug.hxx>
  38
  39 #include <svtools/smplhint.hxx>
  40 #include <svtools/cnclhint.hxx>
  41 #include <rtl/instance.hxx>
  42
  43 namespace { struct lclMutex : public rtl::Static< ::vos::OMutex, lclMutex >{}; }
  44
  45 //=========================================================================
  46
  47 SfxCancelManager::SfxCancelManager( SfxCancelManager *pParent )
  48 :       _pParent( pParent )
  49 {
  50 }
  51
  52 //-------------------------------------------------------------------------
  53
  54 SfxCancelManager::~SfxCancelManager()
  55 {
  56     DBG_ASSERT( _pParent || !_aJobs.Count(), "deleting SfxCancelManager in use" );
  57     for ( USHORT n = _aJobs.Count(); n--; )
  58         _aJobs.GetObject(n)->SetManager( _pParent );
  59 }
  60
  61 //-------------------------------------------------------------------------
  62
  63 BOOL SfxCancelManager::CanCancel() const
  64
  65 /*      [Beschreibung]
  66
  67     Liefert TRUE wenn an diesem CancelManager oder an einem Parent
  68     ein Job l"auft.
  69 */
  70
  71 {
  72     ::vos::OGuard aGuard( lclMutex::get() );
  73     return _aJobs.Count() > 0 || ( _pParent && _pParent->CanCancel() );
  74 }
  75
  76 //-------------------------------------------------------------------------
  77
  78 void SfxCancelManager::Cancel( BOOL bDeep )
  79
  80 /*      [Beschreibung]
  81
  82     Diese Methode markiert alle angemeldeten <SfxCancellable>-Instanzen
  83     als suspendiert.
  84 */
  85
  86 {
  87     ::vos::OGuard aGuard( lclMutex::get() );
  88     SfxCancelManagerWeak xWeak( this );
  89     for ( USHORT n = _aJobs.Count(); n-- && xWeak.Is(); )
  90         if ( n < _aJobs.Count() )
  91             _aJobs.GetObject(n)->Cancel();
  92     if ( xWeak.Is() && _pParent )
  93         _pParent->Cancel( bDeep );
  94 }
  95
  96 //-------------------------------------------------------------------------
  97
  98 void SfxCancelManager::InsertCancellable( SfxCancellable *pJob )
  99
 100 /*      [Beschreibung]
 101
 102     Diese interne Methode tr"agt 'pJob' in die Liste der unterbrechbaren
 103     Jobs ein und Broadcastet dies. Jeder <SfxCancellable> darf nur
 104     maximal einmal angemeldet sein, dies geschiet in seinem Ctor.
 105 */
 106
 107 {
 108 #ifdef GPF_ON_EMPTY_TITLE
 109     if ( !pJob->GetTitle() )
 110     {
 111         DBG_ERROR( "SfxCancellable: empty titles not allowed (Vermummungsverbot)" )
 112         *(int*)0 = 0;
 113     }
 114 #endif
 115
 116     ::vos::OClearableGuard aGuard( lclMutex::get() );
 117     _aJobs.C40_INSERT( SfxCancellable, pJob, _aJobs.Count() );
 118
 119     aGuard.clear();
 120     Broadcast( SfxSimpleHint( SFX_HINT_CANCELLABLE ) );
 121 }
 122
 123 //-------------------------------------------------------------------------
 124
 125
 126 void SfxCancelManager::RemoveCancellable( SfxCancellable *pJob )
 127
 128 /*      [Beschreibung]
 129
 130     Diese interne Methode tr"agt 'pJob' aus die Liste der unterbrechbaren
 131     Jobs aus und Broadcastet dies. Dieser Aufruf mu\s paarig nach einem
 132     <InsertCancellable> erfolgen und wird im Dtor des <SfxCancellable>
 133     ausgel"ost.
 134 */
 135
 136 {
 137     ::vos::OClearableGuard aGuard( lclMutex::get() );
 138     const SfxCancellable *pTmp = pJob;
 139     USHORT nPos = _aJobs.GetPos( pTmp );
 140     if ( nPos != 0xFFFF )
 141     {
 142         _aJobs.Remove( nPos , 1 );
 143         aGuard.clear();
 144         Broadcast( SfxSimpleHint( SFX_HINT_CANCELLABLE ) );
 145         Broadcast( SfxCancelHint( pJob, SFXCANCELHINT_REMOVED ) );
 146     }
 147 }
 148
 149 //-------------------------------------------------------------------------
 150
 151 SfxCancellable::~SfxCancellable()
 152 {
 153     SfxCancelManager* pMgr = _pMgr;
 154     if ( pMgr )
 155         pMgr->RemoveCancellable( this );
 156 }
 157
 158 //-------------------------------------------------------------------------
 159
 160 void SfxCancellable::Cancel()
 161
 162 /*      [Description]
 163
 164     This virtual function is called when the user hits the cancel-button.
 165     If you overload it, you can stop your activities. Please always call
 166     'SfxCancellable::Cancel()'.
 167 */
 168
 169 {
 170 #ifdef GFP_ON_NO_CANCEL
 171     if ( _bCancelled < 5 )
 172         ++_bCancelled;
 173     else
 174     {
 175         delete this;
 176     }
 177 #else
 178     _bCancelled = TRUE;
 179 #endif
 180 }
 181
 182 //-------------------------------------------------------------------------
 183
 184 void SfxCancellable::SetManager( SfxCancelManager *pMgr )
 185 {
 186     SfxCancelManager* pTmp = _pMgr;
 187     if ( pTmp )
 188         pTmp->RemoveCancellable( this );
 189     _pMgr = pMgr;
 190     if ( pMgr )
 191         pMgr->InsertCancellable( this );
 192 }
 193
 194 //-------------------------------------------------------------------------
 195
 196 TYPEINIT1(SfxCancelHint, SfxHint);
 197
 198 SfxCancelHint::SfxCancelHint( SfxCancellable* pJob, USHORT _nAction )
 199 {
 200     pCancellable = pJob;
 201     nAction = _nAction;
 202 }
 203
 204