.. _program_listing_file_src_ompl_util_Console.h:

Program Listing for File Console.h
==================================

|exhale_lsh| :ref:`Return to documentation for file <file_src_ompl_util_Console.h>` (``src/ompl/util/Console.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*********************************************************************
   * 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: Ioan Sucan */
   
   #ifndef OMPL_UTIL_CONSOLE_
   #define OMPL_UTIL_CONSOLE_
   
   #include <string>
   
   #define OMPL_ERROR(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_ERROR, fmt, ##__VA_ARGS__)
   
   #define OMPL_WARN(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_WARN, fmt, ##__VA_ARGS__)
   
   #define OMPL_INFORM(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_INFO, fmt, ##__VA_ARGS__)
   
   #define OMPL_DEBUG(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_DEBUG, fmt, ##__VA_ARGS__)
   
   #define OMPL_DEVMSG1(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_DEV1, fmt, ##__VA_ARGS__)
   
   #define OMPL_DEVMSG2(fmt, ...) ompl::msg::log(__FILE__, __LINE__, ompl::msg::LOG_DEV2, fmt, ##__VA_ARGS__)
   
   namespace ompl
   {
       namespace msg
       {
           enum LogLevel
           {
               LOG_DEV2 = -2,  // message type for developers
               LOG_DEV1 = -1,  // message type for developers
               LOG_DEBUG = 0,
               LOG_INFO,
               LOG_WARN,
               LOG_ERROR,
               LOG_NONE
           };
   
           class OutputHandler
           {
           public:
               OutputHandler() = default;
   
               virtual ~OutputHandler() = default;
   
               virtual void log(const std::string &text, LogLevel level, const char *filename, int line) = 0;
           };
   
           class OutputHandlerSTD : public OutputHandler
           {
           public:
               OutputHandlerSTD() = default;
   
               void log(const std::string &text, LogLevel level, const char *filename, int line) override;
           };
   
           class OutputHandlerFile : public OutputHandler
           {
           public:
               OutputHandlerFile(const char *filename);
   
               ~OutputHandlerFile() override;
   
               void log(const std::string &text, LogLevel level, const char *filename, int line) override;
   
           private:
               FILE *file_;
           };
   
           void noOutputHandler();
   
           void restorePreviousOutputHandler();
   
           void useOutputHandler(OutputHandler *oh);
   
           OutputHandler *getOutputHandler();
   
           void setLogLevel(LogLevel level);
   
           LogLevel getLogLevel();
   
           void log(const char *file, int line, LogLevel level, const char *m, ...);
       }
   }
   
   #endif