src/SUIT/utilities.h

   1 //  SALOME Utils : general SALOME's definitions and tools
   2 //
   3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 //  This library is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU Lesser General Public
   8 //  License as published by the Free Software Foundation; either
   9 //  version 2.1 of the License.
  10 //
  11 //  This library is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 //  Lesser General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU Lesser General Public
  17 //  License along with this library; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : utilities.h
  25 //  Author : Antoine YESSAYAN, Paul RASCLE, EDF
  26 //  Module : SALOME
  27 //  $Header$
  28
  29 /* ---  Definition macros file to print informations if _DEBUG_ is defined --- */
  30
  31 #ifndef UTILITIES_H
  32 #define UTILITIES_H
  33
  34 #include <iostream>
  35 #include <sstream>
  36 #include <cstdlib>
  37
  38
  39 #include "LocalTraceBufferPool.hxx"
  40
  41 /** \file utilities.h
  42  * For each message to put in the trace, a specific ostingstream object is \n
  43  * created and destroyed automatically at the end of the message macro. \n
  44  * The insert function of LocalTraceBufferPool class gets a buffer in a \n
  45  * buffer pool (unique with the help of mutexes and semaphores) and copy the \n
  46  * message in the buffer.\n
  47  * This buffer is read later by a specific thread in charge of trace print.\n
  48  * Order of trace entries is globally respected. Nevertheless, if there are \n
  49  * several threads waiting for a free buffer to trace, the order of \n
  50  * thread waken up is not garanteed (no fifo or priority rules in Linux Kernel)
  51  */
  52
  53 #define MESS_INIT(deb) std::ostringstream os; os<<deb
  54 #define MESS_BEGIN(deb) MESS_INIT(deb)<<__FILE__ <<" ["<<__LINE__<<"] : "
  55 #define MESS_END std::endl; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, os.str().c_str());
  56 #define MESS_ABORT std::endl; LocalTraceBufferPool::instance()->insert(ABORT_MESS, os.str().c_str());
  57
  58 // --- Some macros are always defined (without _DEBUG_): for use with release version
  59
  60 #define INFOS(msg) {MESS_BEGIN("- Trace ") << msg << MESS_END}
  61 #define PYSCRIPT(msg) {MESS_INIT("---PYSCRIPT--- ") << msg << MESS_END}
  62 #define INTERRUPTION(msg) {MESS_BEGIN("- INTERRUPTION: ")<< msg << MESS_ABORT}
  63 #define IMMEDIATE_ABORT(code) {std::cout <<std::flush; \
  64                                std::cerr << "- ABORT " << __FILE__ << " [" <<__LINE__<< "] : " << flush; \
  65                                std::cerr << "ABORT return code= "<< code << std::endl; \
  66                                std::exit(code);}
  67
  68 /* --- To print date and time of compilation of current source --- */
  69
  70 #if defined ( __GNUC__ )
  71 #define COMPILER                "g++"
  72 #elif defined ( __sun )
  73 #define COMPILER                "CC"
  74 #elif defined ( __KCC )
  75 #define COMPILER                "KCC"
  76 #elif defined ( __PGI )
  77 #define COMPILER                "pgCC"
  78 #elif defined ( __alpha )
  79 #define COMPILER                "cxx"
  80 #else
  81 #define COMPILER                "undefined"
  82 #endif
  83
  84 #ifdef INFOS_COMPILATION
  85 #error INFOS_COMPILATION already defined
  86 #endif
  87
  88 #define INFOS_COMPILATION { MESS_BEGIN("COMPILED with ") << COMPILER \
  89                                        << ", " << __DATE__ \
  90                                        << " at " << __TIME__ << MESS_END }
  91 #ifdef _DEBUG_
  92
  93 /** @name the following MACROS are useful at debug time*/
  94 //@{
  95 #define MESSAGE(msg) {MESS_BEGIN("- Trace ") << msg << MESS_END}
  96 #define SCRUTE(var)  {MESS_BEGIN("- Trace ") << #var << "=" << var <<MESS_END}
  97
  98 #define REPERE ("------- ")
  99 #define BEGIN_OF(msg) {MESS_BEGIN(REPERE) << "Begin of: "      << msg << MESS_END}
 100 #define END_OF(msg)   {MESS_BEGIN(REPERE) << "Normal end of: " << msg << MESS_END}
 101
 102 #ifndef ASSERT
 103 #define ASSERT(condition) \
 104         if (!(condition)){INTERRUPTION("CONDITION "<<#condition<<" NOT VERIFIED")}
 105 #endif /* ASSERT */
 106 //@}
 107
 108 #else /* ifdef _DEBUG_*/
 109
 110 #define MESSAGE(msg) {}
 111 #define SCRUTE(var) {}
 112 #define REPERE
 113 #define BEGIN_OF(msg) {}
 114 #define END_OF(msg) {}
 115
 116 #ifndef ASSERT
 117 #define ASSERT(condition) {}
 118 #endif /* ASSERT */
 119
 120 #endif /* ifdef _DEBUG_*/
 121
 122 #endif /* ifndef UTILITIES_H */