1 #ifndef __DALI_INTEGRATION_DEBUG_H__
2 #define __DALI_INTEGRATION_DEBUG_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
27 #include <dali/public-api/common/dali-common.h>
29 // Using Debug namespace alias shortens the log usage significantly
30 namespace Dali{namespace Integration{namespace Log{}}}
31 namespace Debug = Dali::Integration::Log;
56 * Used by logging macros to log a message along with function/class name
57 * @param level debug level
58 * @param format string format
60 DALI_IMPORT_API void LogMessage(enum DebugPriority level,const char *format, ...);
63 * typedef for the logging function.
65 typedef void (*LogFunction)(DebugPriority priority, std::string& message);
68 * A log function has to be installed for every thread that wants to use logging.
69 * This should be done by the adaptor.
70 * The log function can be different for each thread.
71 * @param logFunction the log function to install
72 * @param logOpts the log options to save in thread
74 DALI_IMPORT_API void InstallLogFunction(const LogFunction& logFunction);
77 * A log function has to be uninstalled for every thread that wants to use logging.
78 * The log function can be different for each thread.
80 DALI_IMPORT_API void UninstallLogFunction();
82 /********************************************************************************
83 * Error/Warning macros. *
84 ********************************************************************************/
87 * Provides unfiltered logging for global error level messages
89 #define DALI_LOG_ERROR(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugError, "%s " format, __PRETTY_FUNCTION__, ## args)
91 #define DALI_LOG_ERROR_NOFN(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugError, format, ## args)
94 * Provides unfiltered logging for fps monitor
96 #define DALI_LOG_FPS(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugInfo, format, ## args)
99 * Provides unfiltered logging for update status
101 #define DALI_LOG_UPDATE_STATUS(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugInfo, format, ## args)
104 * Provides unfiltered logging for render information
106 #define DALI_LOG_RENDER_INFO(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugInfo, format, ## args)
111 * Provides unfiltered logging for global warning level messages
113 #define DALI_LOG_WARNING(format, args...) Dali::Integration::Log::LogMessage(Dali::Integration::Log::DebugWarning, "%s " format, __PRETTY_FUNCTION__, ## args)
116 #else // DEBUG_ENABLED
118 // Don't warn on release build
119 #define DALI_LOG_WARNING(format, args...)
123 /********************************************************************************
125 ********************************************************************************/
130 * Enumeration of logging levels.
131 * Used by the filters to provide multiple log levels.
132 * In general, the higher the value, the more debug is available for that filter.
144 * The Filter object is used by the DALI_LOG_INFO macro and others to determine if the logging
145 * should take place, and routes the logging via the platform abstraction's LogMessage.
147 * It provides a logging level. If this is set to zero, then DALI_LOG_INFO won't log anything.
148 * It provides the ability to turn tracing on or off.
151 class DALI_IMPORT_API Filter
154 typedef std::list<Filter*> FilterList;
155 typedef std::list<Filter*>::iterator FilterIter;
160 * Test if the filter is enabled for the given logging level
161 * @param[in] level - the level to test.
162 * @return true if this level of logging is enabled.
164 bool IsEnabledFor(LogLevel level) { return level != Debug::NoLogging && level <= mLoggingLevel;}
167 * Test if trace is enabled for this filter.
168 * @return true if trace is enabled;
170 bool IsTraceEnabled() { return mTraceEnabled; }
173 * Enable tracing on this filter.
175 void EnableTrace() { mTraceEnabled = true; }
178 * Disable tracing on this filter.
180 void DisableTrace() { mTraceEnabled = false; }
183 * Set the log level for this filter. Setting to a higher value than Debug::General also
186 void SetLogLevel(LogLevel level) { mLoggingLevel = level; }
189 * Perform the logging for this filter.
191 void Log(LogLevel level, const char* format, ...);
194 * Create a new filter whose debug level and trace can be modified through the use of an
195 * environment variable.
197 * @param[in] level The default log level
198 * @param[in] trace The default trace level. If true, function tracing is on.
199 * @param[in] environmentVariableName The environment variable name used in order to change the
200 * log level or trace.
202 * @info To modify logg level/trace at runtime, you can should define your filter as shown below:
205 * Debug::Filter* filter = Debug::Filter::New( Debug::NoLogging, false, "FILTER_ENV" );
208 * And to use it when running an executable:
210 * FILTER_ENV=3 dali-demo // LogLevel Verbose, Trace using default
211 * FILTER_ENV=1,true dali-demo // LogLevel Concise, Trace ON
212 * FILTER_ENV=2,false dali-demo // LogLevel General, Trace OFF
213 * FILTER_ENV=0,true dali-demo // LogLevel NoLogging, Trace ON
216 static Filter* New(LogLevel level, bool trace, const char * environmentVariableName );
219 * Enable trace on all filters.
221 void EnableGlobalTrace();
224 * Disable trace on all filters.
226 void DisableGlobalTrace();
232 * @param[in] level - the highest log level.
233 * @param[in] trace - whether this filter allows tracing.
235 Filter(LogLevel level, bool trace) : mLoggingLevel(level), mTraceEnabled(trace), mNesting(0) {}
237 static FilterList* GetActiveFilters();
240 // High level filters. If these filters are too broad for your current requirement, then
241 // you can add a filter to your own class or source file. If you do, use Filter::New()
242 // to tell this class about it.
244 static Filter *gRender;
245 static Filter *gResource;
246 static Filter *gGLResource;
247 static Filter *gObject;
248 static Filter *gImage;
249 static Filter *gModel;
250 static Filter *gNode;
251 static Filter *gElement;
252 static Filter *gActor;
253 static Filter *gShader;
254 static Filter *gDynamics;
257 LogLevel mLoggingLevel;
265 #define DALI_LOG_FILTER_SET_LEVEL(filter, level) filter->SetLogLevel(level)
266 #define DALI_LOG_FILTER_ENABLE_TRACE(filter) filter->EnableTrace()
267 #define DALI_LOG_FILTER_DISABLE_TRACE(filter) filter->DisableTrace()
271 #define DALI_LOG_FILTER_SET_LEVEL(filter, level)
272 #define DALI_LOG_FILTER_ENABLE_TRACE(filter)
273 #define DALI_LOG_FILTER_DISABLE_TRACE(filter)
277 /********************************************************************************
278 * General Logging macros *
279 ********************************************************************************/
283 #define DALI_LOG_INFO(filter, level, format, args...) \
284 if(filter && filter->IsEnabledFor(level)) { filter->Log(level, format, ## args); }
286 #else // DEBUG_ENABLED
288 #define DALI_LOG_INFO(filter, level, format, args...)
290 #endif // DEBUG_ENABLED
293 /********************************************************************************
295 ********************************************************************************/
298 * These macros allow the instrumentation of methods. These translate into calls
299 * to LogMessage(DebugInfo).
304 class DALI_IMPORT_API TraceObj
307 TraceObj(Filter* filter, const char* fmt, ...);
311 std::string mMessage;
316 #define DALI_LOG_TRACE_METHOD_FMT(filter, format, args...) \
317 Dali::Integration::Log::TraceObj debugTraceObj(filter, "%s: " format, __PRETTY_FUNCTION__, ## args)
319 #define DALI_LOG_TRACE_METHOD(filter) \
320 Dali::Integration::Log::TraceObj debugTraceObj(filter, __PRETTY_FUNCTION__)
323 #else // DEBUG_ENABLED
325 #define DALI_LOG_TRACE_METHOD_FMT(filter, format, args...)
326 #define DALI_LOG_TRACE_METHOD(filter)
331 /********************************************************************************
332 * Extra object debug *
333 ********************************************************************************/
338 * Warning, this macro changes the current scope, so should usually be put at the
339 * end of the class definition.
341 * Suggest that the value is usually set to the object's name.
342 * Warning - this will increase the size of the object for a debug build.
344 #define DALI_LOG_OBJECT_STRING_DECLARATION \
346 std::string mDebugString;
349 * Print all the actor tree names
351 #define DALI_LOG_ACTOR_TREE( node ) { \
352 std::stringstream branch; \
353 Node* tempNode = node; \
354 while( tempNode ) { \
355 branch << "<" << tempNode->mDebugString << ">::"; \
356 tempNode = tempNode->GetParent(); \
358 DALI_LOG_ERROR_NOFN("Actor tree: %s\n", branch.str().c_str()); \
362 * Allows one object to set another object's debug string
364 #define DALI_LOG_SET_OBJECT_STRING(object, string) (object->mDebugString = string)
367 * Allows one object to set another object's std::string easily
369 #define DALI_LOG_FMT_OBJECT_STRING(object, fmt, args...) (object->mDebugString = FormatToString(fmt, ## args))
372 * Allows one object to get another object's debug string
374 #define DALI_LOG_GET_OBJECT_STRING(object) (object->mDebugString)
377 * Get the C string (for use in formatted logging)
379 #define DALI_LOG_GET_OBJECT_C_STR(object) (object->mDebugString.c_str())
382 * Filtered logging of the object's debug string
384 #define DALI_LOG_OBJECT(filter, object) DALI_LOG_INFO(filter, Debug::General, object->mDebugString)
387 #else // DEBUG_ENABLED
389 #define DALI_LOG_OBJECT_STRING_DECLARATION
390 #define DALI_LOG_ACTOR_TREE(node)
391 #define DALI_LOG_SET_OBJECT_STRING(object, string)
392 #define DALI_LOG_FMT_OBJECT_STRING(object, fmt, args...)
393 #define DALI_LOG_GET_OBJECT_STRING(object)
394 #define DALI_LOG_GET_OBJECT_C_STR(object) ""
395 #define DALI_LOG_OBJECT(filter, object)
399 /********************************************************************************
401 ********************************************************************************/
404 * Helper method to translate a color to a string.
405 * @param[in] color - the color to translate
406 * @return string - the text representation of the color.
408 DALI_IMPORT_API std::string ColorToString(const Vector4& color);
411 * Helper method to translate a vector4 to a string.
412 * @param[in] v - the vector
413 * @param[in] precision - the precision to write the float data.
414 * @param[in] indent - the indent level to use.
415 * @return string - the text representation of the vector.
417 DALI_IMPORT_API std::string Vector4ToString(const Vector4& v, size_t precision=3, size_t indent=0);
420 * Helper method to translate a vector4 to a string.
421 * @param[in] v - the vector
422 * @param[in] precision - the precision to write the float data.
423 * @param[in] indent - the indent level to use.
424 * @return string - the text representation of the vector.
426 DALI_IMPORT_API std::string Vector3ToString(const Vector3& v, size_t precision=3, size_t indent=0);
429 * Helper method to translate a quaternion to a string.
430 * @param[in] q the quaternion
431 * @param[in] precision - the precision to write the float data.
432 * @param[in] indent - the indent level to use.
433 * @return string - the text representation of the quaternion.
435 DALI_IMPORT_API std::string QuaternionToString(const Quaternion& q, size_t precision=3, size_t indent=0);
438 * Helper method to translate a 3x3 matrix to a string.
439 * @param[in] m - the matrix
440 * @param[in] precision - the precision to write the float data.
441 * @param[in] indent - the indent level to use.
442 * @return string - the text representation of the vector.
444 DALI_IMPORT_API std::string Matrix3ToString(const Matrix3& m, size_t precision=3, size_t indent=0);
447 * Helper method to translate a 4x4 matrix to a string.
448 * @param[in] m - the matrix
449 * @param[in] precision - the precision to write the float data.
450 * @param[in] indent - the indent level to use.
451 * @return string - the text representation of the vector.
453 DALI_IMPORT_API std::string MatrixToString(const Matrix& m, size_t precision=3, size_t indent=0);
459 * Filtered write of a matrix
461 #define DALI_LOG_MATRIX(filter, matrix) DALI_LOG_INFO(filter, Debug::General, MatrixToString(matrix))
464 * Filtered write of a vector
466 #define DALI_LOG_VECTOR4(filter, vector) DALI_LOG_INFO(filter, Debug::General, Vector4ToString(vector))
469 * Filtered write of a vector
471 #define DALI_LOG_VECTOR3(filter, vector) DALI_LOG_INFO(filter, Debug::General, Vector3ToString(vector))
474 * Filtered write of a color
476 #define DALI_LOG_COLOR(filter, color) DALI_LOG_INFO(filter, Debug::General, ColorToString(color))
480 #define DALI_LOG_MATRIX(filter, matrix)
481 #define DALI_LOG_VECTOR4(filter,vector)
482 #define DALI_LOG_VECTOR3(filter,vector)
483 #define DALI_LOG_COLOR(filter, color)
487 }}} // Dali/Integration/Debug namespaces
490 #endif // __DALI_INTEGRATION_DEBUG_H__