framework/inc/macros/debug/registration.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: registration.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 #ifndef __FRAMEWORK_MACROS_DEBUG_REGISTRATION_HXX_
  32 #define __FRAMEWORK_MACROS_DEBUG_REGISTRATION_HXX_
  33
  34 //*****************************************************************************************************************
  35 //      special macros for assertion handling
  36 //*****************************************************************************************************************
  37
  38 #ifdef  ENABLE_REGISTRATIONDEBUG
  39
  40     //_____________________________________________________________________________________________________________
  41     //  includes
  42     //_____________________________________________________________________________________________________________
  43
  44     #ifndef _RTL_STRBUF_HXX_
  45     #include <rtl/strbuf.hxx>
  46     #endif
  47
  48     /*_____________________________________________________________________________________________________________
  49         LOGFILE_ASSERTIONS
  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_REGISTRATION
  55         #define LOGFILE_REGISTRATION                                                                                                                                                    \
  56                     "registration.log"
  57     #endif
  58
  59     /*_____________________________________________________________________________________________________________
  60         LOG_REGISTRATION_WRITEINFO( SINFOTEXT )
  61
  62         Write informations for component_writeInfo() in log file.
  63     _____________________________________________________________________________________________________________*/
  64
  65     #define     LOG_REGISTRATION_WRITEINFO( SINFOTEXT )                                                                                                                         \
  66                 {                                                                                                                                                                                               \
  67                     ::rtl::OStringBuffer sOut( 1024 );                                                                                                                  \
  68                     sOut.append( "component_writeInfo():" );                                                                                                    \
  69                     sOut.append( SINFOTEXT                );                                                                                                    \
  70                     WRITE_LOGFILE( LOGFILE_REGISTRATION, sOut.makeStringAndClear() )                                                    \
  71                 }
  72
  73     /*_____________________________________________________________________________________________________________
  74         LOG_REGISTRATION_WRITEINFO( SINFOTEXT )
  75
  76         Write informations for component_getFactory() in log file.
  77     _____________________________________________________________________________________________________________*/
  78
  79     #define     LOG_REGISTRATION_GETFACTORY( SINFOTEXT )                                                                                                                        \
  80                 {                                                                                                                                                                                               \
  81                     ::rtl::OStringBuffer sOut( 1024 );                                                                                                                  \
  82                     sOut.append( "component_getFactory():" );                                                                                                   \
  83                     sOut.append( SINFOTEXT                 );                                                                                                   \
  84                     WRITE_LOGFILE( LOGFILE_REGISTRATION, sOut.makeStringAndClear() )                                                    \
  85                 }
  86
  87 #else   // #ifdef ENABLE_REGISTRATIONDEBUG
  88
  89     /*_____________________________________________________________________________________________________________
  90         If right testmode is'nt set - implements these macro empty!
  91     _____________________________________________________________________________________________________________*/
  92
  93     #undef      LOGFILE_REGISTRATION
  94     #define     LOG_REGISTRATION_WRITEINFO( SINFOTEXT )
  95     #define     LOG_REGISTRATION_GETFACTORY( SINFOTEXT )
  96
  97 #endif  // #ifdef ENABLE_REGISTRATIONDEBUG
  98
  99 //*****************************************************************************************************************
 100 //      end of file
 101 //*****************************************************************************************************************
 102
 103 #endif  // #ifndef __FRAMEWORK_MACROS_DEBUG_REGISTRATION_HXX_