1 // Copyright (C) 2007-2023 CEA, EDF, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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, or (at your option) any later version.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SALOME Utils : general SALOME's definitions and tools
25 // Author : Antoine YESSAYAN, Paul RASCLE, EDF
29 /* --- Definition macros file to print information if _DEBUG_ is defined --- */
39 #include "LocalTraceBufferPool.hxx"
40 #include "libSALOMELog.hxx"
43 * For each message to put in the trace, a specific ostingstream object is
44 * created and destroyed automatically at the end of the message macro.
45 * The insert function of LocalTraceBufferPool class gets a buffer in a
46 * buffer pool (unique with the help of mutexes and semaphores) and copy the
47 * message in the buffer.
48 * This buffer is read later by a specific thread in charge of trace print.
49 * Order of trace entries is globally respected. Nevertheless, if there are
50 * several threads waiting for a free buffer to trace, the order of
51 * thread waken up is not guaranteed (no fifo or priority rules in Linux Kernel)
54 #define MESS_INIT(deb) std::ostringstream os; os<<deb
55 #define MESS_BEGIN(deb) MESS_INIT(deb)<<__FILE__ <<" ["<<__LINE__<<"] : "
56 #define MESS_END std::endl; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, os.str().c_str());
57 #define MESS_ABORT std::endl; LocalTraceBufferPool::instance()->insert(ABORT_MESS, os.str().c_str());
59 // Macros for messages with separated structure in c++ file in _DEBUG mode
60 #define MESSAGE_BEGIN(msg) {std::ostringstream ss; ss <<__FILE__ <<" ["<<__LINE__<<"] : "<< msg; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, ss.str().c_str());}
61 #define MESSAGE_ADD(msg) {std::ostringstream ss; ss << msg; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, ss.str().c_str());}
62 #define MESSAGE_END(msg) {std::ostringstream ss; ss << msg << std::endl; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, ss.str().c_str());}
64 // --- Some macros are always defined (without _DEBUG_): for use with release version
66 #define INFOS(msg) {MESS_BEGIN("- Trace ") << msg << MESS_END}
67 #define BRIEF_INFOS(msg) {std::cout << msg << std::endl;}
68 #define PYSCRIPT(msg) {MESS_INIT("---PYSCRIPT--- ") << msg << MESS_END}
69 #define INTERRUPTION(msg) {MESS_BEGIN("- INTERRUPTION: ")<< msg << MESS_ABORT}
72 #define IMMEDIATE_ABORT(code) {std::cout <<std::flush; \
73 std::cerr << "- ABORT " << __FILE__ << " [" <<__LINE__<< "] : " << std::flush; \
74 std::cerr << "ABORT return code= "<< code << std::endl; \
77 #define IMMEDIATE_ABORT(code) {std::cout <<std::flush; \
78 std::cerr << "- ABORT " << __FILE__ << " [" <<__LINE__<< "] : " << std::flush; \
79 std::cerr << "ABORT return code= "<< code << std::endl; \
83 /* --- To print date and time of compilation of current source --- */
85 #if defined ( __GNUC__ )
86 #define COMPILER "g++"
87 #elif defined ( __sun )
89 #elif defined ( __KCC )
90 #define COMPILER "KCC"
91 #elif defined ( __PGI )
92 #define COMPILER "pgCC"
93 #elif defined ( __alpha )
94 #define COMPILER "cxx"
95 #elif defined ( _MSC_VER )
96 #define COMPILER "cl.exe"
98 #define COMPILER "undefined"
101 #ifdef INFOS_COMPILATION
102 #error INFOS_COMPILATION already defined
105 // --- the following MACROS can be enabled in debug and release versions
106 // --- by SALOME_VERBOSE environment variable
108 #define INFOS_COMPILATION { if (SALOME::VerbosityActivated()) { MESS_BEGIN("COMPILED with ") << COMPILER \
109 << ", " << __DATE__ \
110 << " at " << __TIME__ << MESS_END }}
113 #define MESSAGE(msg) { if (SALOME::VerbosityActivated()) {MESS_BEGIN("- Trace ") << msg << MESS_END}}
114 #define SCRUTE(var) { if (SALOME::VerbosityActivated()) {MESS_BEGIN("- Trace ") << #var << "=" << var <<MESS_END}}
116 #define REPERE ("------- ")
117 #define BEGIN_OF(msg) { if (SALOME::VerbosityActivated()) {MESS_BEGIN(REPERE) << "Begin of: " << msg << MESS_END}}
118 #define END_OF(msg) { if (SALOME::VerbosityActivated()) {MESS_BEGIN(REPERE) << "Normal end of: " << msg << MESS_END}}
121 #define ASSERT(condition) \
122 { if (SALOME::VerbosityActivated()) { \
123 if (!(condition)){INTERRUPTION("CONDITION "<<#condition<<" NOT VERIFIED")} \
127 #endif /* ifndef UTILITIES_H */