Version: 8.3.0
utilities.h
Go to the documentation of this file.
1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 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, or (at your option) any later version.
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.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 // SALOME Utils : general SALOME's definitions and tools
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 
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 // Macroses for messages with separated structure in c++ file in _DUBUG mode
59 #define MESSAGE_BEGIN(msg) {std::ostringstream ss; ss <<__FILE__ <<" ["<<__LINE__<<"] : "<< msg; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, ss.str().c_str());}
60 #define MESSAGE_ADD(msg) {std::ostringstream ss; ss << msg; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, ss.str().c_str());}
61 #define MESSAGE_END(msg) {std::ostringstream ss; ss << msg << std::endl; LocalTraceBufferPool::instance()->insert(NORMAL_MESS, ss.str().c_str());}
62 
63 // --- Some macros are always defined (without _DEBUG_): for use with release version
64 
65 #define INFOS(msg) {MESS_BEGIN("- Trace ") << msg << MESS_END}
66 #define PYSCRIPT(msg) {MESS_INIT("---PYSCRIPT--- ") << msg << MESS_END}
67 #define INTERRUPTION(msg) {MESS_BEGIN("- INTERRUPTION: ")<< msg << MESS_ABORT}
68 
69 #ifdef WIN32
70 #define IMMEDIATE_ABORT(code) {std::cout <<std::flush; \
71  std::cerr << "- ABORT " << __FILE__ << " [" <<__LINE__<< "] : " << std::flush; \
72  std::cerr << "ABORT return code= "<< code << std::endl; \
73  /*std::*/exit(code);}
74 #else
75 #define IMMEDIATE_ABORT(code) {std::cout <<std::flush; \
76  std::cerr << "- ABORT " << __FILE__ << " [" <<__LINE__<< "] : " << std::flush; \
77  std::cerr << "ABORT return code= "<< code << std::endl; \
78  std::exit(code);}
79 #endif
80 
81 /* --- To print date and time of compilation of current source --- */
82 
83 #if defined ( __GNUC__ )
84 #define COMPILER "g++"
85 #elif defined ( __sun )
86 #define COMPILER "CC"
87 #elif defined ( __KCC )
88 #define COMPILER "KCC"
89 #elif defined ( __PGI )
90 #define COMPILER "pgCC"
91 #elif defined ( __alpha )
92 #define COMPILER "cxx"
93 #else
94 #define COMPILER "undefined"
95 #endif
96 
97 #ifdef INFOS_COMPILATION
98 #error INFOS_COMPILATION already defined
99 #endif
100 
101 #if defined(_DEBUG_) || defined(_DEBUG)
102 
103 // --- the following MACROS are useful at debug time
104 
105 #define INFOS_COMPILATION { MESS_BEGIN("COMPILED with ") << COMPILER \
106  << ", " << __DATE__ \
107  << " at " << __TIME__ << MESS_END }
108 
109 #define MESSAGE(msg) {MESS_BEGIN("- Trace ") << msg << MESS_END}
110 #define SCRUTE(var) {MESS_BEGIN("- Trace ") << #var << "=" << var <<MESS_END}
111 
112 #define REPERE ("------- ")
113 #define BEGIN_OF(msg) {MESS_BEGIN(REPERE) << "Begin of: " << msg << MESS_END}
114 #define END_OF(msg) {MESS_BEGIN(REPERE) << "Normal end of: " << msg << MESS_END}
115 
116 #ifndef ASSERT
117 #define ASSERT(condition) \
118  if (!(condition)){INTERRUPTION("CONDITION "<<#condition<<" NOT VERIFIED")}
119 #endif /* ASSERT */
120 
121 
122 #else /* ifdef _DEBUG_*/
123 
124 #define INFOS_COMPILATION
125 #define MESSAGE(msg) {}
126 #define SCRUTE(var) {}
127 #define REPERE
128 #define BEGIN_OF(msg) {}
129 #define END_OF(msg) {}
130 
131 #ifndef ASSERT
132 #define ASSERT(condition) {}
133 #endif /* ASSERT */
134 
135 #endif /* ifdef _DEBUG_*/
136 
137 #endif /* ifndef UTILITIES_H */