framework/inc/macros/debug/logmechanism.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: logmechanism.hxx,v $
  10  * $Revision: 1.5 $
  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_LOGMECHANISM_HXX_
  32 #define __FRAMEWORK_MACROS_DEBUG_LOGMECHANISM_HXX_
  33
  34 //*****************************************************************************************************************
  35 //      generic macros for logging
  36 //*****************************************************************************************************************
  37
  38 #ifdef  ENABLE_LOGMECHANISM
  39
  40     //_____________________________________________________________________________________________________________
  41     //  includes
  42     //_____________________________________________________________________________________________________________
  43
  44     #ifndef _RTL_STRING_HXX_
  45     #include <rtl/string.hxx>
  46     #endif
  47
  48     #include <stdio.h>
  49
  50     /*_____________________________________________________________________________________________________________
  51         WRITE_LOGFILE( SFILENAME, STEXT )
  52
  53         Log any information in file. We append any information at file and don't clear it anymore.
  54         ( Use new scope in macro to declare pFile more then on time in same "parentscope"!
  55             Don't control pFile before access! What will you doing if its not valid? Log an error ...
  56               An error and an error is an error ... )
  57
  58         Attention:  You must use "%s" and STEXT as parameter ... because otherwise encoded strings (they include e.g. %...)
  59                     are handled wrong.
  60     _____________________________________________________________________________________________________________*/
  61
  62     #define     WRITE_LOGFILE( SFILENAME, STEXT )                                                                                                                                       \
  63                 {                                                                                                                                                                                               \
  64                     ::rtl::OString      _swriteLogfileFileName  ( SFILENAME     );                                                                              \
  65                     ::rtl::OString      _swriteLogfileText              ( STEXT         );                                                                              \
  66                     FILE* pFile = fopen( _swriteLogfileFileName.getStr(), "a" );                                                                \
  67                     fprintf( pFile, "%s", _swriteLogfileText.getStr() );                                        \
  68                     fclose ( pFile                                    );                                        \
  69                 }
  70
  71     /*_____________________________________________________________________________________________________________
  72         LOGTYPE
  73
  74         For other debug macros we need information about the output mode. If user forget to set this information we
  75         do it for him. Valid values are:        LOGTYPE_FILECONTINUE
  76                                             LOGTYPE_FILEEXIT
  77                                             LOGTYPE_MESSAGEBOX
  78         The normal case is LOGTYPE_MESSAGEBOX to show assertions in normal manner!
  79     _____________________________________________________________________________________________________________*/
  80
  81     #define     LOGTYPE_MESSAGEBOX              1
  82     #define     LOGTYPE_FILECONTINUE    2
  83     #define     LOGTYPE_FILEEXIT                3
  84
  85     #ifndef     LOGTYPE
  86         #define LOGTYPE                                                                                                                                                                                 \
  87                     LOGTYPE_MESSAGEBOX
  88     #endif
  89
  90 #else   // #ifdef ENABLE_LOGMECHANISM
  91
  92     /*_____________________________________________________________________________________________________________
  93         If right testmode is'nt set - implements these macro empty!
  94     _____________________________________________________________________________________________________________*/
  95
  96     #define     WRITE_LOGFILE( SFILENAME, STEXT )
  97     #undef      LOGTYPE
  98
  99 #endif  // #ifdef ENABLE_LOGMECHANISM
 100
 101 //*****************************************************************************************************************
 102 //      end of file
 103 //*****************************************************************************************************************
 104
 105 #endif  // #ifndef __FRAMEWORK_MACROS_DEBUG_LOGMECHANISM_HXX_