Onboard-SDK/osdk-core/hal/inc/dji_log.hpp

/** @file dji_log.hpp
 *  @version 3.3
 *  @date Jun 15 2017
 *
 *  @brief
 *  Logging mechanism for printing status and error messages to the screen.
 *
 *  @Copyright (c) 2016-2017 DJI
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

#ifndef LOG_H
#define LOG_H

#include "dji_memory.hpp"
#include "dji_singleton.hpp"
#include "dji_thread_manager.hpp"

#ifdef WIN32
#define __func__ __FUNCTION__
#endif // WIN32

#define DLOG(_title_)                                                          \
  DJI::OSDK::Log::instance()                                                   \
    .title((_title_), #_title_, __func__, __LINE__)                            \
    .print

#define DLOG_PRIVATE(_title_)                                                  \
  DJI::OSDK::Log::instance()                                                   \
    .title((_title_), #_title_)                            \
    .print

#define STATUS DJI::OSDK::Log::instance().getStatusLogState()
#define ERRORLOG DJI::OSDK::Log::instance().getErrorLogState()
#define DEBUG DJI::OSDK::Log::instance().getDebugLogState()

/*! @brief Global Logging macro for status messages
 *  @details Users can use methods in the DJI::OSDK::Log class to
 *  enable/disable this logging channel
 */
#define DSTATUS DLOG(STATUS)
#define DSTATUS_PRIVATE DLOG_PRIVATE(STATUS)

/*! @brief Global Logging macro for error messages
 *  @details Users can use methods in the DJI::OSDK::Log class to
 *  enable/disable this logging channel
 */
#define DERROR DLOG(ERRORLOG)
#define DERROR_PRIVATE DLOG_PRIVATE(ERRORLOG)

/*! @brief Global Logging macro for debug messages
 *  @details Users can use methods in the DJI::OSDK::Log class to
 *  enable/disable this logging channel
 */
#define DDEBUG DLOG(DEBUG)
#define DDEBUG_PRIVATE DLOG_PRIVATE(DEBUG)

namespace DJI
{
namespace OSDK
{

//! @todo text stream and string class

/*! @brief Logger for DJI OSDK supporting different logging channels
 *
 * @details The Log class is a singleton and contains some pre-defined logging levels.
 * The class provides methods to turn on or off these predefined logging levels.
 * Users can also create their own logging channels using the DLOG macro.
 */
class Log : public Singleton<Log>
{
public:
  Log(Mutex* m = 0);
  ~Log();

  //! @note if title level is 0, this log would not be print at all
  //! this feature is used for dynamical/statical optional log output
  Log& title(int level, const char* prefix, const char* func, int line);

  //! @note Used for closed source logging, where we don't want to
  //! print function name and line number
  Log& title(int level, const char* prefix);

  Log& print();

  /*!
   * @brief Enable logging of status messages called through DSTATUS macro
   * @details Call this method on the DJI::OSDK::Log.instance() in your program.
   */
  void enableStatusLogging();

  /*!
   * @brief Disable logging of status messages called through DSTATUS macro
   * @details Call this method on the DJI::OSDK::Log.instance() in your program.
   */
  void disableStatusLogging();

  /*!
   * @brief Enable logging of status messages called through DDEBUG macro
   * @details Call this method on the DJI::OSDK::Log.instance() in your program.
   */
  void enableDebugLogging();

  /*!
   * @brief Disable logging of status messages called through DDEBUG macro
   * @details Call this method on the DJI::OSDK::Log.instance() in your program.
   */
  void disableDebugLogging();

  /*!
   * @brief Enable logging of status messages called through DERROR macro
   * @details Call this method on the DJI::OSDK::Log.instance() in your program.
   */
  void enableErrorLogging();

  /*!
   * @brief Disable logging of status messages called through DERROR macro
   * @details Call this method on the DJI::OSDK::Log.instance() in your program.
   */
  void disableErrorLogging();

  // Retrieve logging switches - used for global macros
  bool getStatusLogState();
  bool getDebugLogState();
  bool getErrorLogState();

  virtual Log& print(const char* fmt, ...);

  Log& operator<<(bool val);
  Log& operator<<(short val);
  Log& operator<<(uint16_t val);
  Log& operator<<(int val);
  Log& operator<<(uint32_t val);
  Log& operator<<(long val);
  Log& operator<<(unsigned long val);
  Log& operator<<(long long val);
  Log& operator<<(unsigned long long val);
  Log& operator<<(float val);
  Log& operator<<(double val);
  Log& operator<<(long double val);
  Log& operator<<(void* val);
  Log& operator<<(char c);
  Log& operator<<(uint8_t c);
  Log& operator<<(int8_t c);
  Log& operator<<(const char* str);

private:
  Mutex* mutex;
  bool   vaild;

  // @todo implement
  typedef enum NUMBER_STYLE {
    STYLE_DEC,
    STYLE_HEX,
    STYLE_BIN,
    STYLE_OCT
  } NUMBER_STYLE;

  // Some default printing mechanism toggles
  bool enable_status;
  bool enable_debug;
  bool enable_error;

  static const bool release = false;
};

} // namespace OSDK
} // namespace DJI

#endif // LOG_H