framework/inc/macros/debug/mutex.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: mutex.hxx,v $
  10  * $Revision: 1.8 $
  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 #ifndef __FRAMEWORK_MACROS_DEBUG_MUTEX_HXX_
  32 #define __FRAMEWORK_MACROS_DEBUG_MUTEX_HXX_
  33
  34 //*****************************************************************************************************************
  35 //      special macros for mutex handling
  36 //*****************************************************************************************************************
  37
  38 #ifdef  ENABLE_MUTEXDEBUG
  39
  40     //_____________________________________________________________________________________________________________
  41     //  includes
  42     //_____________________________________________________________________________________________________________
  43
  44     #ifndef _RTL_STRBUF_HXX_
  45     #include <rtl/strbuf.hxx>
  46     #endif
  47
  48     /*_____________________________________________________________________________________________________________
  49         LOGFILE_MUTEX
  50
  51         For follow macros we need a special log file. If user forget to specify anyone, we must do it for him!
  52     _____________________________________________________________________________________________________________*/
  53
  54     #ifndef     LOGFILE_MUTEX
  55         #define LOGFILE_MUTEX   "mutex.log"
  56     #endif
  57
  58     /*_____________________________________________________________________________________________________________
  59         LOG_LOCKTYPE( _EFALLBACK, _ECURRENT )
  60
  61         Write informations about current set lock type for whole framework project to special file.
  62     _____________________________________________________________________________________________________________*/
  63
  64     #define LOG_LOCKTYPE( _EFALLBACK, _ECURRENT )                                                               \
  65                 /* new scope to prevent us against multiple definitions of variables ... */                     \
  66                 {                                                                                               \
  67                     ::rtl::OStringBuffer _sBuffer( 256 );                                                       \
  68                     _sBuffer.append( "Set framework lock type to fallback: \"" );                               \
  69                     switch( _EFALLBACK )                                                                        \
  70                     {                                                                                           \
  71                         case E_NOTHING      :   _sBuffer.append( "E_NOTHING"    );                              \
  72                                                 break;                                                          \
  73                         case E_OWNMUTEX     :   _sBuffer.append( "E_OWNMUTEX"   );                              \
  74                                                 break;                                                          \
  75                         case E_SOLARMUTEX   :   _sBuffer.append( "E_SOLARMUTEX" );                              \
  76                                                 break;                                                          \
  77                         case E_FAIRRWLOCK   :   _sBuffer.append( "E_FAIRRWLOCK" );                              \
  78                                                 break;                                                          \
  79                     }                                                                                           \
  80                     _sBuffer.append( "\"\n" );                                                                  \
  81                     if( _EFALLBACK != _ECURRENT )                                                               \
  82                     {                                                                                           \
  83                         _sBuffer.append( "... environment overwrite framework lock type with: \"" );            \
  84                         switch( _ECURRENT )                                                                     \
  85                         {                                                                                       \
  86                             case E_NOTHING      :   _sBuffer.append( "E_NOTHING"    );                          \
  87                                                     break;                                                      \
  88                             case E_OWNMUTEX     :   _sBuffer.append( "E_OWNMUTEX"   );                          \
  89                                                     break;                                                      \
  90                             case E_SOLARMUTEX   :   _sBuffer.append( "E_SOLARMUTEX" );                          \
  91                                                     break;                                                      \
  92                             case E_FAIRRWLOCK   :   _sBuffer.append( "E_FAIRRWLOCK" );                          \
  93                                                     break;                                                      \
  94                         }                                                                                       \
  95                         _sBuffer.append( "\"\n" );                                                              \
  96                     }                                                                                           \
  97                     else                                                                                        \
  98                     {                                                                                           \
  99                         _sBuffer.append( "... use fallback, because user don't set another value!\n" );         \
 100                     }                                                                                           \
 101                     WRITE_LOGFILE( LOGFILE_MUTEX, _sBuffer.makeStringAndClear() )                               \
 102                 }
 103
 104 #else   // #ifdef ENABLE_MUTEXDEBUG
 105
 106     /*_____________________________________________________________________________________________________________
 107         If right testmode is'nt set - implements these macro with normal functionality!
 108         We need the guard but not the log mechanism.
 109     _____________________________________________________________________________________________________________*/
 110
 111     #undef      LOGFILE_MUTEX
 112     #define LOG_LOCKTYPE( _EFALLBACK, _ECURRENT )
 113
 114 #endif  // #ifdef ENABLE_MUTEXDEBUG
 115
 116 //*****************************************************************************************************************
 117 //      end of file
 118 //*****************************************************************************************************************
 119
 120 #endif  // #ifndef __FRAMEWORK_MACROS_DEBUG_MUTEX_HXX_