sal/inc/systools/win32/SyncObjects.hxx

   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: SyncObjects.hxx,v $
  10  * $Revision: 1.4 $
  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
  32 #ifndef _SYNCOBJECTS_HXX_
  33 #define _SYNCOBJECTS_HXX_
  34
  35 //------------------------------------------------------------------------
  36 // includes
  37 //------------------------------------------------------------------------
  38
  39 #include <windows.h>
  40
  41 //------------------------------------------------------------------------
  42 // a simple helper template for automatic locking/unlocking
  43 //------------------------------------------------------------------------
  44
  45 template< class LOCK >
  46 class CLockGuard
  47 {
  48 public:
  49     CLockGuard( LOCK* aLock ) :
  50         m_pLock( aLock )
  51     {
  52         m_pLock->Lock( );
  53     }
  54
  55     ~CLockGuard( )
  56     {
  57         m_pLock->Unlock( );
  58     }
  59
  60 private:
  61     LOCK* m_pLock;
  62 };
  63
  64 //------------------------------------------------------------------------
  65 // a interface base class for different locking sub classes
  66 //------------------------------------------------------------------------
  67
  68 class CSyncObject
  69 {
  70 public:
  71     virtual ~CSyncObject( ) = 0;
  72
  73     virtual int Lock( )     = 0;
  74     virtual int Unlock( )   = 0;
  75 };
  76
  77 //------------------------------------------------------------------------
  78 // if no synchronization is necessary this class will be used
  79 // declaring the functions as inline safes runtime overhead
  80 //------------------------------------------------------------------------
  81
  82 class CNullLock
  83 {
  84 public:
  85     inline virtual ~CNullLock ( ) {};
  86     inline virtual int Lock( )    {};
  87     inline virtual int Unlock()   {};
  88 };
  89
  90 //------------------------------------------------------------------------
  91 // a minimal wrapper for a win32 critical section
  92 //------------------------------------------------------------------------
  93
  94 class CCriticalSection : public CSyncObject
  95 {
  96 public:
  97     CCriticalSection( );
  98     virtual ~CCriticalSection( );
  99
 100     // both functions return always 0
 101     // because the win32 critsec functions
 102     // don't return any return code
 103     virtual int Lock( );
 104     virtual int Unlock( );
 105
 106 private:
 107     CRITICAL_SECTION m_critSec;
 108 };
 109
 110
 111 typedef CLockGuard< CSyncObject > SyncObjLockGuard_t;
 112
 113 #endif