OpENer/source/src/trace.h

/*******************************************************************************
 * Copyright (c) 2009, Rockwell Automation, Inc.
 * All rights reserved.
 *
 ******************************************************************************/
#ifndef OPENER_TRACE_H_
#define OPENER_TRACE_H_

#include <opener_user_conf.h>

/** @file trace.h
 * @brief Tracing infrastructure for OpENer
 */

#ifdef OPENER_WITH_TRACES

/** @def OPENER_TRACE_LEVEL_ERROR Enable tracing of error messages. This is the
 *  default if no trace level is given.
 */
#define OPENER_TRACE_LEVEL_ERROR 0x01

/** @def OPENER_TRACE_LEVEL_WARNING Enable tracing of warning messages */
#define OPENER_TRACE_LEVEL_WARNING 0x02

/** @def OPENER_TRACE_LEVEL_WARNING Enable tracing of state messages */
#define OPENER_TRACE_LEVEL_STATE 0x04

/** @def OPENER_TRACE_LEVEL_INFO Enable tracing of info messages*/
#define OPENER_TRACE_LEVEL_INFO 0x08

#ifndef OPENER_TRACE_LEVEL
#ifdef WIN32
#pragma message( \
  "OPENER_TRACE_LEVEL was not defined setting it to OPENER_TRACE_LEVEL_ERROR")
#else
#warning \
  OPENER_TRACE_LEVEL was not defined setting it to OPENER_TRACE_LEVEL_ERROR
#endif

#define OPENER_TRACE_LEVEL OPENER_TRACE_LEVEL_ERROR
#endif

/* @def OPENER_TRACE_ENABLED Can be used for conditional code compilation */
#define OPENER_TRACE_ENABLED

/** @def OPENER_TRACE_ERR(...) Trace error messages.
 *  In order to activate this trace level set the OPENER_TRACE_LEVEL_ERROR flag
 *  in OPENER_TRACE_LEVEL.
 */
#define OPENER_TRACE_ERR(...)                                                  \
  do {                                                                         \
    if (OPENER_TRACE_LEVEL_ERROR & OPENER_TRACE_LEVEL) {LOG_TRACE(__VA_ARGS__);} \
  } while (0)

/** @def OPENER_TRACE_WARN(...) Trace warning messages.
 *  In order to activate this trace level set the OPENER_TRACE_LEVEL_WARNING
 * flag in OPENER_TRACE_LEVEL.
 */
#define OPENER_TRACE_WARN(...)                           \
  do {                                                   \
    if (OPENER_TRACE_LEVEL_WARNING & OPENER_TRACE_LEVEL) { \
      LOG_TRACE(__VA_ARGS__);}                            \
  } while (0)

/** @def OPENER_TRACE_STATE(...) Trace state messages.
 *  In order to activate this trace level set the OPENER_TRACE_LEVEL_STATE flag
 *  in OPENER_TRACE_LEVEL.
 */
#define OPENER_TRACE_STATE(...)                                                \
  do {                                                                         \
    if (OPENER_TRACE_LEVEL_STATE & OPENER_TRACE_LEVEL) {LOG_TRACE(__VA_ARGS__);} \
  } while (0)

/** @def OPENER_TRACE_INFO(...) Trace information messages.
 *  In order to activate this trace level set the OPENER_TRACE_LEVEL_INFO flag
 *  in OPENER_TRACE_LEVEL.
 */
#define OPENER_TRACE_INFO(...)                                                \
  do {                                                                        \
    if (OPENER_TRACE_LEVEL_INFO & OPENER_TRACE_LEVEL) {LOG_TRACE(__VA_ARGS__);} \
  } while (0)

#else
/* define the tracing macros empty in order to save space */

#define OPENER_TRACE_ERR(...)
#define OPENER_TRACE_WARN(...)
#define OPENER_TRACE_STATE(...)
#define OPENER_TRACE_INFO(...)
#endif
/* TRACING *******************************************************************/

#endif /*OPENER_TRACE_H_*/