Logger.h

Go to the documentation of this file.

/*
 * This is a part of the Uniot project.
 * Copyright (C) 2016-2020 Uniot <contact@uniot.io>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

 
#pragma once

#ifndef __FUNC_NAME__
#if defined(__GNUC__) || defined(__clang__)
  #define __FUNC_NAME__ __func__
#else
  #define __FUNC_NAME__ __FUNCTION__
#endif
#endif

#define UNIOT_LOG_LEVEL_ERROR 0
#define UNIOT_LOG_LEVEL_WARN  1
#define UNIOT_LOG_LEVEL_INFO  2
#define UNIOT_LOG_LEVEL_DEBUG 3
#define UNIOT_LOG_LEVEL_TRACE 4

#ifndef UNIOT_LOG_LEVEL
#define UNIOT_LOG_LEVEL UNIOT_LOG_LEVEL_DEBUG
#endif

#if UNIOT_LOG_ENABLED
 
#include <Arduino.h>

#ifndef UNIOT_LOG_STREAM
#define UNIOT_LOG_STREAM Serial
#endif

#ifndef UNIOT_LOG_BAUD_RATE
#define UNIOT_LOG_BAUD_RATE 115200
#endif

#ifndef UNIOT_LOG_BUF_SIZE
#define UNIOT_LOG_BUF_SIZE 256
#endif

#ifndef UNIOT_LOG_SET_READY
#define UNIOT_LOG_SET_READY()          \
  do {                                 \
    if (!UNIOT_LOG_STREAM) {                 \
      UNIOT_LOG_STREAM.begin(UNIOT_LOG_BAUD_RATE); \
      UNIOT_LOG_STREAM.print("\n\n");        \
    }                                  \
  } while (0)
#endif

#ifndef UNIOT_LOG_PRINT
#define UNIOT_LOG_PRINT(...)         \
  do {                               \
    if (UNIOT_LOG_STREAM)                  \
      UNIOT_LOG_STREAM.print(__VA_ARGS__); \
  } while (0)
#endif

#define UNIOT_LOG(log_type, log_fmt, log_arg...)                         \
  do {                                                                   \
    uniot_log_printf("[" #log_type "][%lu][%s:%d][%s] " log_fmt "\n",    \
                     millis(), __FILE__, __LINE__, __FUNC_NAME__, ##log_arg); \
  } while (0)

#define UNIOT_LOG_IF(log_type, log_cond, log_fmt, log_arg...) \
  do {                                                        \
    if (log_cond)                                             \
      UNIOT_LOG(log_type, log_fmt, ##log_arg);                \
  } while (0)

static inline int
uniot_log_printf(const char *format, ...) {
  va_list arg;
  va_start(arg, format);
  char buf[UNIOT_LOG_BUF_SIZE];
  int len = vsnprintf(buf, sizeof(buf), format, arg);
  va_end(arg);
  UNIOT_LOG_PRINT(buf);
  if (len >= (int)sizeof(buf))
    UNIOT_LOG_PRINT(" [...]\n");
  return len;
}
 
#else  /* UNIOT_LOG_ENABLED not defined */
#include <Common.h>
 
#define UNIOT_LOG_SET_READY() do {} while(0)
#define UNIOT_LOG_PRINT(...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG(log_type, ...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG_IF(log_type, ...) (UNUSED(__VA_ARGS__))
#endif
 
#if UNIOT_LOG_LEVEL_ERROR <= UNIOT_LOG_LEVEL
#define UNIOT_LOG_ERROR(...) UNIOT_LOG(ERROR, __VA_ARGS__)
#define UNIOT_LOG_ERROR_IF(log_cond, log...) UNIOT_LOG_IF(ERROR, log_cond, ##log)
#else
#define UNIOT_LOG_ERROR(...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG_ERROR_IF(...) (UNUSED(__VA_ARGS__))
#endif
 
#if UNIOT_LOG_LEVEL_WARN <= UNIOT_LOG_LEVEL
#define UNIOT_LOG_WARN(...) UNIOT_LOG(WARN, __VA_ARGS__)
#define UNIOT_LOG_WARN_IF(log_cond, log...) UNIOT_LOG_IF(WARN, log_cond, ##log)
#else
#define UNIOT_LOG_WARN(...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG_WARN_IF(...) (UNUSED(__VA_ARGS__))
#endif
 
#if UNIOT_LOG_LEVEL_INFO <= UNIOT_LOG_LEVEL
#define UNIOT_LOG_INFO(...) UNIOT_LOG(INFO, __VA_ARGS__)
#define UNIOT_LOG_INFO_IF(log_cond, log...) UNIOT_LOG_IF(INFO, log_cond, ##log)
#else
#define UNIOT_LOG_INFO(...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG_INFO_IF(...) (UNUSED(__VA_ARGS__))
#endif
 
#if UNIOT_LOG_LEVEL_DEBUG <= UNIOT_LOG_LEVEL
#define UNIOT_LOG_DEBUG(...) UNIOT_LOG(DEBUG, __VA_ARGS__)
#define UNIOT_LOG_DEBUG_IF(log_cond, log...) UNIOT_LOG_IF(DEBUG, log_cond, ##log)
#else
#define UNIOT_LOG_DEBUG(...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG_DEBUG_IF(...) (UNUSED(__VA_ARGS__))
#endif
 
#if UNIOT_LOG_LEVEL_TRACE <= UNIOT_LOG_LEVEL
#define UNIOT_LOG_TRACE(...) UNIOT_LOG(TRACE, __VA_ARGS__)
#define UNIOT_LOG_TRACE_IF(log_cond, log...) UNIOT_LOG_IF(TRACE, log_cond, ##log)
#else
#define UNIOT_LOG_TRACE(...) (UNUSED(__VA_ARGS__))
#define UNIOT_LOG_TRACE_IF(...) (UNUSED(__VA_ARGS__))
#endif