console.h

Go to the documentation of this file.

/*********************************************************************
* Software License Agreement (BSD License)
*
*  Copyright (c) 2008, Willow Garage, Inc.
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*   * Neither the name of the Willow Garage nor the names of its
*     contributors may be used to endorse or promote products derived
*     from this software without specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
*  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
*  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
*  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
*  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
*  POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/
 
/* Author: Ryan Luna, Ioan Sucan */
 
#ifndef INCLUDE_CONSOLE_BRIDGE_CONSOLE_H_
#define INCLUDE_CONSOLE_BRIDGE_CONSOLE_H_
 
#include <string>
 
#include "./console_bridge_export.h"
 
#define CONSOLE_BRIDGE_logError(...)  \
  console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_ERROR, __VA_ARGS__)
 
#define CONSOLE_BRIDGE_logWarn(...)   \
  console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_WARN,  __VA_ARGS__)
 
#define CONSOLE_BRIDGE_logInform(...) \
  console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_INFO,  __VA_ARGS__)
 
#define CONSOLE_BRIDGE_logDebug(...)  \
  console_bridge::log(__FILE__, __LINE__, console_bridge::CONSOLE_BRIDGE_LOG_DEBUG, __VA_ARGS__)
 
namespace console_bridge
{
enum CONSOLE_BRIDGE_DLLAPI LogLevel
  {
    CONSOLE_BRIDGE_LOG_DEBUG = 0,
    CONSOLE_BRIDGE_LOG_INFO,
    CONSOLE_BRIDGE_LOG_WARN,
    CONSOLE_BRIDGE_LOG_ERROR,
    CONSOLE_BRIDGE_LOG_NONE
  };
 
class CONSOLE_BRIDGE_DLLAPI OutputHandler
{
public:
  OutputHandler(void){}
 
  virtual ~OutputHandler(void){}
 
  virtual void log(const std::string &text, LogLevel level, const char *filename, int line) = 0;
};
 
class CONSOLE_BRIDGE_DLLAPI OutputHandlerSTD : public OutputHandler
{
public:
  OutputHandlerSTD(void) : OutputHandler(){}
 
  virtual void log(const std::string &text, LogLevel level, const char *filename, int line);
};
 
class CONSOLE_BRIDGE_DLLAPI OutputHandlerFile : public OutputHandler
{
public:
  explicit OutputHandlerFile(const char *filename);
 
  virtual ~OutputHandlerFile(void);
 
  virtual void log(const std::string &text, LogLevel level, const char *filename, int line);
 
private:
  FILE *file_;
};
 
CONSOLE_BRIDGE_DLLAPI void noOutputHandler(void);
 
CONSOLE_BRIDGE_DLLAPI void restorePreviousOutputHandler(void);
 
CONSOLE_BRIDGE_DLLAPI void useOutputHandler(OutputHandler *oh);
 
CONSOLE_BRIDGE_DLLAPI OutputHandler* getOutputHandler(void);
 
CONSOLE_BRIDGE_DLLAPI void setLogLevel(LogLevel level);
 
CONSOLE_BRIDGE_DLLAPI LogLevel getLogLevel(void);
 
CONSOLE_BRIDGE_DLLAPI void log(const char *file,
                               int line,
                               LogLevel level,
                               const char* m,
                               ...);
}  // namespace console_bridge
 
#endif  // INCLUDE_CONSOLE_BRIDGE_CONSOLE_H_