otsdaq  v2_04_02
CoutMacros.h
1 #ifndef _ots_Cout_Macros_h_
2 #define _ots_Cout_Macros_h_
3 
4 // clang-format off
5 
6 #include <string.h> //for strstr (not the same as <string>)
7 #include <iostream> //for cout
8 #include <sstream> //for stringstream, std::stringbuf
9 
10 #include "tracemf.h"
11 
12 // take filename only after srcs/ (this gives by repo name)
13 #define __SHORTFILE__ (strstr(&__FILE__[0], "/srcs/") ? strstr(&__FILE__[0], "/srcs/") + 6 : __FILE__)
14 
15 // take only file name
16 #define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
17 
18 #define __E__ std::endl
19 
20 #define __THROW__(X) throw std::runtime_error(X)
21 
22 //un-comment __COUT_TO_STD__ to send __COUT__ directly to std::cout, rather than through message facility
23 //#define __COUT_TO_STD__ 1
24 
28 
29 #define __MF_SUBJECT__ "ots" // default subject.. others can #undef and re-#define
30 // Note: to turn off MF everywhere, just replace with std::cout here at __MF_TYPE__(X)!
31 
32 #define Q(X) #X
33 #define QUOTE(X) Q(X)
34 //#define __MF_TYPE__(X) FIXME ?? how to do this ...(__ENV__("OTSDAQ_USING_MF")=="1"?
35 // mf::X (__MF_SUBJECT__) : std::cout << QUOTE(X) << ":" << __MF_SUBJECT__ << ":")
36 
37 #define __COUT_HDR_F__ __SHORTFILE__ << "\t"
38 #define __COUT_HDR_L__ "[" << std::dec << __LINE__ << "]\t"
39 #define __COUT_HDR_P__ __PRETTY_FUNCTION__ << "\t"
40 #define __COUT_HDR_FL__ __SHORTFILE__ << " " << __COUT_HDR_L__
41 #define __COUT_HDR_FP__ __SHORTFILE__ << " : " << __COUT_HDR_P__
42 #define __COUT_HDR__ ""//__COUT_HDR_FL__
43 #define __MF_HDR__ ""//__COUT_HDR__
44 
46 #define __MF_DECOR__ (__MF_SUBJECT__)
47 #define __MF_TYPE__(X) TLOG(X, __MF_DECOR__)
48 
49 #ifndef __COUT_TO_STD__
50 #define __COUT_TYPE__(X) __MF_TYPE__(X)
51 #else
52 #define __COUT_TYPE__(X) std::cout << QUOTE(X) << ":" << __MF_DECOR__ << ":" << __COUT_HDR_FL__
53 #endif
54 
55 #define __MOUT_ERR__ __MF_TYPE__(TLVL_ERROR) << __MF_HDR__
56 #define __MOUT_WARN__ __MF_TYPE__(TLVL_WARNING) << __MF_HDR__
57 #define __MOUT_INFO__ __MF_TYPE__(TLVL_INFO) << __MF_HDR__
58 #define __MOUT__ __MF_TYPE__(TLVL_DEBUG) << __MF_HDR__
59 #define __MOUTV__(X) __MOUT__ << QUOTE(X) << " = " << X
60 
61 #define __COUT_ERR__ __COUT_TYPE__(TLVL_ERROR) << __COUT_HDR__
62 #define __COUT_WARN__ __COUT_TYPE__(TLVL_WARNING) << __COUT_HDR__
63 #define __COUT_INFO__ __COUT_TYPE__(TLVL_INFO) << __COUT_HDR__
64 #define __COUT__ __COUT_TYPE__(TLVL_DEBUG) << __COUT_HDR__
65 #define __COUTT__ __COUT_TYPE__(TLVL_TRACE) << __COUT_HDR__
66 #define __COUTV__(X) __COUT__ << QUOTE(X) << " = " << X << __E__
67 #define __COUTTV__(X) __COUTT__ << QUOTE(X) << " = " << X << __E__
68 
69 
74 #define __MCOUT_ERR__(X) { __MOUT_ERR__ << X; __COUT_ERR__ << X; }
75 #define __MCOUT_WARN__(X) { __MOUT_WARN__ << X; __COUT_WARN__ << X; }
76 #define __MCOUT_INFO__(X) { __MOUT_INFO__ << X; __COUT_INFO__ << X; }
77 #define __MCOUT__(X) { __MOUT__ << X; __COUT__ << X; }
78 #define __MCOUTV__(X) { __MOUTV__(X); __COUTV__(X); }
79 
81 
82 #define __SS__ std::stringstream ss; ss << ":" << __MF_DECOR__ << ":" << __COUT_HDR_FL__
83 #define __SS_THROW__ { __COUT_ERR__ << "\n" << ss.str(); throw std::runtime_error(ss.str()); } //put in {}'s to prevent surprises, e.g. if ... else __SS_THROW__;
84 #define __SS_ONLY_THROW__ throw std::runtime_error(ss.str())
85 #define __SSV__(X) __SS__ << QUOTE(X) << " = " << X
86 
88 // for configurable objects, add name to subject
89 #define __CFG_MF_DECOR__ (__MF_SUBJECT__ + std::string(":") + theConfigurationRecordName_)
90 #define __CFG_MF_TYPE__(X) TLOG(X, __CFG_MF_DECOR__)
91 
92 #ifndef __COUT_TO_STD__
93 #define __CFG_COUT_TYPE__(X) __CFG_MF_TYPE__(X)
94 #else
95 #define __CFG_COUT_TYPE__(X) std::cout << QUOTE(X) << ":" << __CFG_MF_DECOR__ << ":" << __COUT_HDR_FL__
96 #endif
97 
98 #define __CFG_MOUT_ERR__ __CFG_MF_TYPE__(TLVL_ERROR) << __COUT_HDR__
99 #define __CFG_MOUT_WARN__ __CFG_MF_TYPE__(TLVL_WARNING) << __COUT_HDR__
100 #define __CFG_MOUT_INFO__ __CFG_MF_TYPE__(TLVL_INFO) << __COUT_HDR__
101 #define __CFG_MOUT__ __CFG_MF_TYPE__(TLVL_DEBUG) << __COUT_HDR__
102 #define __CFG_MOUTV__(X) __CFG_MOUT__ << QUOTE(X) << " = " << X
103 #define __CFG_COUT_ERR__ __CFG_COUT_TYPE__(TLVL_ERROR) << __COUT_HDR__
104 #define __CFG_COUT_WARN__ __CFG_COUT_TYPE__(TLVL_WARNING) << __COUT_HDR__
105 #define __CFG_COUT_INFO__ __CFG_COUT_TYPE__(TLVL_INFO) << __COUT_HDR__
106 #define __CFG_COUT__ __CFG_COUT_TYPE__(TLVL_DEBUG) << __COUT_HDR__
107 #define __CFG_COUTV__(X) __CFG_COUT__ << QUOTE(X) << " = " << X << __E__
108 
109 #define __CFG_MCOUT_ERR__(X) { __CFG_MOUT_ERR__ << X; __CFG_COUT_ERR__ << X; }
110 #define __CFG_MCOUT_WARN__(X) { __CFG_MOUT_WARN__ << X; __CFG_COUT_WARN__ << X; }
111 #define __CFG_MCOUT_INFO__(X) { __CFG_MOUT_INFO__ << X; __CFG_COUT_INFO__ << X; }
112 #define __CFG_MCOUT__(X) { __CFG_MOUT__ << X; __CFG_COUT__ << X; }
113 #define __CFG_MCOUTV__(X) { __CFG_MOUTV__(X); __CFG_COUTV__(X); }
114 
115 #define __CFG_SS__ std::stringstream ss; ss << ":" << __CFG_MF_DECOR__ << ":" << __COUT_HDR_FL__
116 #define __CFG_SS_THROW__ { __CFG_COUT_ERR__ << "\n" << ss.str(); throw std::runtime_error(ss.str()); }
117 
119 
120 // for front-end interface objects, add name to subject
121 #define __FE_MF_DECOR__ ("FE:" + getInterfaceType() + std::string(":") + getInterfaceUID() + ":" + theConfigurationRecordName_)
122 #define __FE_MF_TYPE__(X) TLOG(X, __FE_MF_DECOR__)
123 
124 #ifndef __COUT_TO_STD__
125 #define __FE_COUT_TYPE__(X) __FE_MF_TYPE__(X)
126 #else
127 #define __FE_COUT_TYPE__(X) std::cout << QUOTE(X) << ":" << __FE_MF_DECOR__ << ":" << __COUT_HDR_FL__
128 #endif
129 
130 #define __FE_MOUT_ERR__ __FE_MF_TYPE__(TLVL_ERROR) << __COUT_HDR__
131 #define __FE_MOUT_WARN__ __FE_MF_TYPE__(TLVL_WARNING) << __COUT_HDR__
132 #define __FE_MOUT_INFO__ __FE_MF_TYPE__(TLVL_INFO) << __COUT_HDR__
133 #define __FE_MOUT__ __FE_MF_TYPE__(TLVL_DEBUG) << __COUT_HDR__
134 #define __FE_MOUTV__(X) __FE_MOUT__ << QUOTE(X) << " = " << X
135 #define __FE_COUT_ERR__ __FE_COUT_TYPE__(TLVL_ERROR) << __COUT_HDR__
136 #define __FE_COUT_WARN__ __FE_COUT_TYPE__(TLVL_WARNING) << __COUT_HDR__
137 #define __FE_COUT_INFO__ __FE_COUT_TYPE__(TLVL_INFO) << __COUT_HDR__
138 #define __FE_COUT__ __FE_COUT_TYPE__(TLVL_DEBUG) << __COUT_HDR__
139 #define __FE_COUTV__(X) __FE_COUT__ << QUOTE(X) << " = " << X << __E__
140 
141 #define __FE_MCOUT_ERR__(X) { __FE_MOUT_ERR__ << X; __FE_COUT_ERR__ << X; }
142 #define __FE_MCOUT_WARN__(X) { __FE_MOUT_WARN__ << X; __FE_COUT_WARN__ << X; }
143 #define __FE_MCOUT_INFO__(X) { __FE_MOUT_INFO__ << X; __FE_COUT_INFO__ << X; }
144 #define __FE_MCOUT__(X) { __FE_MOUT__ << X; __FE_COUT__ << X; }
145 #define __FE_MCOUTV__(X) { __FE_MOUTV__(X); __FE_COUTV__(X); }
146 
147 #define __FE_SS__ std::stringstream ss; ss << ":" << __FE_MF_DECOR__ << ":" << __COUT_HDR_FL__
148 #define __FE_SS_THROW__ { __FE_COUT_ERR__ << "\n" << ss.str(); throw std::runtime_error(ss.str()); }
149 
151 
152 // for generic decoration override, just have mfSubject declared
153 #define __GEN_MF_DECOR__ (mfSubject_)
154 #define __GEN_MF_TYPE__(X) TLOG(X, __GEN_MF_DECOR__)
155 
156 #ifndef __COUT_TO_STD__
157 #define __GEN_COUT_TYPE__(X) __GEN_MF_TYPE__(X)
158 #else
159 #define __GEN_COUT_TYPE__(X) std::cout << QUOTE(X) << ":" << __GEN_MF_DECOR__ << ":" << __COUT_HDR_FL__
160 #endif
161 
162 #define __GEN_MOUT_ERR__ __GEN_MF_TYPE__(TLVL_ERROR) << __COUT_HDR__
163 #define __GEN_MOUT_WARN__ __GEN_MF_TYPE__(TLVL_WARNING) << __COUT_HDR__
164 #define __GEN_MOUT_INFO__ __GEN_MF_TYPE__(TLVL_INFO) << __COUT_HDR__
165 #define __GEN_MOUT__ __GEN_MF_TYPE__(TLVL_DEBUG) << __COUT_HDR__
166 #define __GEN_MOUTV__(X) __GEN_MOUT__ << QUOTE(X) << " = " << X
167 #define __GEN_COUT_ERR__ __GEN_COUT_TYPE__(TLVL_ERROR) << __COUT_HDR__
168 #define __GEN_COUT_WARN__ __GEN_COUT_TYPE__(TLVL_WARNING) << __COUT_HDR__
169 #define __GEN_COUT_INFO__ __GEN_COUT_TYPE__(TLVL_INFO) << __COUT_HDR__
170 #define __GEN_COUT__ __GEN_COUT_TYPE__(TLVL_DEBUG) << __COUT_HDR__
171 #define __GEN_COUTV__(X) __GEN_COUT__ << QUOTE(X) << " = " << X << __E__
172 
173 #define __GEN_MCOUT_ERR__(X) { __GEN_MOUT_ERR__ << X; __GEN_COUT_ERR__ << X; }
174 #define __GEN_MCOUT_WARN__(X) { __GEN_MOUT_WARN__ << X; __GEN_COUT_WARN__ << X; }
175 #define __GEN_MCOUT_INFO__(X) { __GEN_MOUT_INFO__ << X; __GEN_COUT_INFO__ << X; }
176 #define __GEN_MCOUT__(X) { __GEN_MOUT__ << X; __GEN_COUT__ << X; }
177 #define __GEN_MCOUTV__(X) { __GEN_MOUTV__(X); __GEN_COUTV__(X); }
178 
179 #define __GEN_SS__ std::stringstream ss; ss << ":" << __GEN_MF_DECOR__ << ":" << __COUT_HDR_FL__
180 #define __GEN_SS_THROW__ { __GEN_COUT_ERR__ << "\n" << ss.str(); throw std::runtime_error(ss.str()); }
181 
183 
184 // for core supervisor objects (with supervisorClassNoNamespace_ defined), add class to
185 // subject
186 #define __SUP_MF_DECOR__ (supervisorClassNoNamespace_ + std::string("-") + CorePropertySupervisorBase::getSupervisorUID())
187 #define __SUP_MF_TYPE__(X) TLOG(X, __SUP_MF_DECOR__) //mf::X(supervisorClassNoNamespace_ + "-" + CorePropertySupervisorBase::getSupervisorUID())
188 
189 #ifndef __COUT_TO_STD__
190 #define __SUP_COUT_TYPE__(X) __SUP_MF_TYPE__(X)
191 #else
192 #define __SUP_COUT_TYPE__(X) std::cout << QUOTE(X) << ":" << __SUP_MF_DECOR__ << ":" << __COUT_HDR_FL__
193 #endif
194 
195 #define __SUP_MOUT_ERR__ __SUP_MF_TYPE__(TLVL_ERROR) << __COUT_HDR__
196 #define __SUP_MOUT_WARN__ __SUP_MF_TYPE__(TLVL_WARNING) << __COUT_HDR__
197 #define __SUP_MOUT_INFO__ __SUP_MF_TYPE__(TLVL_INFO) << __COUT_HDR__
198 #define __SUP_MOUT__ __SUP_MF_TYPE__(TLVL_DEBUG) << __COUT_HDR__
199 #define __SUP_MOUTV__(X) __SUP_MOUT__ << QUOTE(X) << " = " << X
200 
201 #define __SUP_COUT_ERR__ __SUP_COUT_TYPE__(TLVL_ERROR) << __COUT_HDR__
202 #define __SUP_COUT_WARN__ __SUP_COUT_TYPE__(TLVL_WARNING) << __COUT_HDR__
203 #define __SUP_COUT_INFO__ __SUP_COUT_TYPE__(TLVL_INFO) << __COUT_HDR__
204 #define __SUP_COUT__ __SUP_COUT_TYPE__(TLVL_DEBUG) << __COUT_HDR__
205 #define __SUP_COUTV__(X) __SUP_COUT__ << QUOTE(X) << " = " << X << __E__
206 
207 #define __SUP_MCOUT_ERR__(X) { __SUP_MOUT_ERR__ << X; __SUP_COUT_ERR__ << X; }
208 #define __SUP_MCOUT_WARN__(X) { __SUP_MOUT_WARN__ << X; __SUP_COUT_WARN__ << X; }
209 #define __SUP_MCOUT_INFO__(X) { __SUP_MOUT_INFO__ << X; __SUP_COUT_INFO__ << X; }
210 #define __SUP_MCOUT__(X) { __SUP_MOUT__ << X; __SUP_COUT__ << X; }
211 #define __SUP_MCOUTV__(X) { __SUP_MOUTV__(X); __SUP_COUTV__(X); }
212 
213 #define __SUP_SS__ std::stringstream ss; ss << ":" << __SUP_MF_DECOR__ << ":" << __COUT_HDR_FL__
214 #define __SUP_SS_THROW__ { __SUP_COUT_ERR__ << "\n" << ss.str(); throw std::runtime_error(ss.str()); }
215 
216 #define __ENV__(X) StringMacros::otsGetEnvironmentVarable(X, std::string(__SHORTFILE__), __LINE__)
217 
218 //========================================================================================================================
219 // const_cast away the const
220 // so that otsdaq is compatible with slf6 and slf7 versions of xdaq
221 // where they changed to const xdaq::ApplicationDescriptor* in slf7
222 #ifdef XDAQ_NOCONST
223 #define XDAQ_CONST_CALL
224 #else
225 #define XDAQ_CONST_CALL const
226 #endif
227 //========================================================================================================================
228 
229 //========================================================================================================================
230 // declare special ots soft exception
231 // a SOFT exception thrown during running workloop by a state machine plugin will
232 // PAUSE the global state machine and allow for manual intervention to resume a run.
233 namespace ots
234 {
235 struct __OTS_SOFT_EXCEPTION__ : public std::exception
236 {
237  __OTS_SOFT_EXCEPTION__(const std::string& what) : what_(what) {}
238  virtual char const* what() const throw() { return what_.c_str(); }
239  std::string what_;
240 };
241 } // end namespace ots
242 
243 #endif
244 
245 // clang-format on