xref: /trunk/main/framework/inc/macros/debug/mutex.hxx (revision 01cec6d620143fc02deecf66cdb0013880d92ac2)
1f8e07b45SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3f8e07b45SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4f8e07b45SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5f8e07b45SAndrew Rist  * distributed with this work for additional information
6f8e07b45SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7f8e07b45SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8f8e07b45SAndrew Rist  * "License"); you may not use this file except in compliance
9f8e07b45SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11f8e07b45SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13f8e07b45SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14f8e07b45SAndrew Rist  * software distributed under the License is distributed on an
15f8e07b45SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16f8e07b45SAndrew Rist  * KIND, either express or implied.  See the License for the
17f8e07b45SAndrew Rist  * specific language governing permissions and limitations
18f8e07b45SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20f8e07b45SAndrew Rist  *************************************************************/
21f8e07b45SAndrew Rist 
22cdf0e10cSrcweir #ifndef __FRAMEWORK_MACROS_DEBUG_MUTEX_HXX_
23cdf0e10cSrcweir #define __FRAMEWORK_MACROS_DEBUG_MUTEX_HXX_
24cdf0e10cSrcweir 
25cdf0e10cSrcweir //*****************************************************************************************************************
26cdf0e10cSrcweir //  special macros for mutex handling
27cdf0e10cSrcweir //*****************************************************************************************************************
28cdf0e10cSrcweir 
29cdf0e10cSrcweir #ifdef  ENABLE_MUTEXDEBUG
30cdf0e10cSrcweir 
31cdf0e10cSrcweir     //_____________________________________________________________________________________________________________
32cdf0e10cSrcweir     //  includes
33cdf0e10cSrcweir     //_____________________________________________________________________________________________________________
34cdf0e10cSrcweir 
35cdf0e10cSrcweir     #ifndef _RTL_STRBUF_HXX_
36cdf0e10cSrcweir     #include <rtl/strbuf.hxx>
37cdf0e10cSrcweir     #endif
38cdf0e10cSrcweir 
39cdf0e10cSrcweir     /*_____________________________________________________________________________________________________________
40cdf0e10cSrcweir         LOGFILE_MUTEX
41cdf0e10cSrcweir 
42cdf0e10cSrcweir         For follow macros we need a special log file. If user forget to specify anyone, we must do it for him!
43cdf0e10cSrcweir     _____________________________________________________________________________________________________________*/
44cdf0e10cSrcweir 
45cdf0e10cSrcweir     #ifndef LOGFILE_MUTEX
46cdf0e10cSrcweir         #define LOGFILE_MUTEX   "mutex.log"
47cdf0e10cSrcweir     #endif
48cdf0e10cSrcweir 
49cdf0e10cSrcweir     /*_____________________________________________________________________________________________________________
50cdf0e10cSrcweir         LOG_LOCKTYPE( _EFALLBACK, _ECURRENT )
51cdf0e10cSrcweir 
52*01cec6d6Smseidel         Write information about current set lock type for whole framework project to special file.
53cdf0e10cSrcweir     _____________________________________________________________________________________________________________*/
54cdf0e10cSrcweir 
55cdf0e10cSrcweir     #define LOG_LOCKTYPE( _EFALLBACK, _ECURRENT )                                                               \
56cdf0e10cSrcweir                 /* new scope to prevent us against multiple definitions of variables ... */                     \
57cdf0e10cSrcweir                 {                                                                                               \
58cdf0e10cSrcweir                     ::rtl::OStringBuffer _sBuffer( 256 );                                                       \
59cdf0e10cSrcweir                     _sBuffer.append( "Set framework lock type to fallback: \"" );                               \
60cdf0e10cSrcweir                     switch( _EFALLBACK )                                                                        \
61cdf0e10cSrcweir                     {                                                                                           \
62cdf0e10cSrcweir                         case E_NOTHING      :   _sBuffer.append( "E_NOTHING"    );                              \
63cdf0e10cSrcweir                                                 break;                                                          \
64cdf0e10cSrcweir                         case E_OWNMUTEX     :   _sBuffer.append( "E_OWNMUTEX"   );                              \
65cdf0e10cSrcweir                                                 break;                                                          \
66cdf0e10cSrcweir                         case E_SOLARMUTEX   :   _sBuffer.append( "E_SOLARMUTEX" );                              \
67cdf0e10cSrcweir                                                 break;                                                          \
68cdf0e10cSrcweir                         case E_FAIRRWLOCK   :   _sBuffer.append( "E_FAIRRWLOCK" );                              \
69cdf0e10cSrcweir                                                 break;                                                          \
70cdf0e10cSrcweir                     }                                                                                           \
71cdf0e10cSrcweir                     _sBuffer.append( "\"\n" );                                                                  \
72cdf0e10cSrcweir                     if( _EFALLBACK != _ECURRENT )                                                               \
73cdf0e10cSrcweir                     {                                                                                           \
74cdf0e10cSrcweir                         _sBuffer.append( "... environment overwrite framework lock type with: \"" );            \
75cdf0e10cSrcweir                         switch( _ECURRENT )                                                                     \
76cdf0e10cSrcweir                         {                                                                                       \
77cdf0e10cSrcweir                             case E_NOTHING      :   _sBuffer.append( "E_NOTHING"    );                          \
78cdf0e10cSrcweir                                                     break;                                                      \
79cdf0e10cSrcweir                             case E_OWNMUTEX     :   _sBuffer.append( "E_OWNMUTEX"   );                          \
80cdf0e10cSrcweir                                                     break;                                                      \
81cdf0e10cSrcweir                             case E_SOLARMUTEX   :   _sBuffer.append( "E_SOLARMUTEX" );                          \
82cdf0e10cSrcweir                                                     break;                                                      \
83cdf0e10cSrcweir                             case E_FAIRRWLOCK   :   _sBuffer.append( "E_FAIRRWLOCK" );                          \
84cdf0e10cSrcweir                                                     break;                                                      \
85cdf0e10cSrcweir                         }                                                                                       \
86cdf0e10cSrcweir                         _sBuffer.append( "\"\n" );                                                              \
87cdf0e10cSrcweir                     }                                                                                           \
88cdf0e10cSrcweir                     else                                                                                        \
89cdf0e10cSrcweir                     {                                                                                           \
90cdf0e10cSrcweir                         _sBuffer.append( "... use fallback, because user don't set another value!\n" );         \
91cdf0e10cSrcweir                     }                                                                                           \
92cdf0e10cSrcweir                     WRITE_LOGFILE( LOGFILE_MUTEX, _sBuffer.makeStringAndClear() )                               \
93cdf0e10cSrcweir                 }
94cdf0e10cSrcweir 
95cdf0e10cSrcweir #else   // #ifdef ENABLE_MUTEXDEBUG
96cdf0e10cSrcweir 
97cdf0e10cSrcweir     /*_____________________________________________________________________________________________________________
98*01cec6d6Smseidel         If right testmode isn't set - implements these macro with normal functionality!
99cdf0e10cSrcweir         We need the guard but not the log mechanism.
100cdf0e10cSrcweir     _____________________________________________________________________________________________________________*/
101cdf0e10cSrcweir 
102cdf0e10cSrcweir     #undef  LOGFILE_MUTEX
103cdf0e10cSrcweir     #define LOG_LOCKTYPE( _EFALLBACK, _ECURRENT )
104cdf0e10cSrcweir 
105cdf0e10cSrcweir #endif  // #ifdef ENABLE_MUTEXDEBUG
106cdf0e10cSrcweir 
107cdf0e10cSrcweir //*****************************************************************************************************************
108cdf0e10cSrcweir //  end of file
109cdf0e10cSrcweir //*****************************************************************************************************************
110cdf0e10cSrcweir 
111cdf0e10cSrcweir #endif  // #ifndef __FRAMEWORK_MACROS_DEBUG_MUTEX_HXX_
112