contrib/opencsd/decoder/include/common/ocsd_msg_logger.h

   1 /*!
   2  * \file       ocsd_msg_logger.h
   3  * \brief      OpenCSD : Generic Message logger / printer
   4  *
   5  * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
   6  */
   7
   8 /*
   9  * Redistribution and use in source and binary forms, with or without modification,
  10  * are permitted provided that the following conditions are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright notice,
  13  * this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  * this list of conditions and the following disclaimer in the documentation
  17  * and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the copyright holder nor the names of its contributors
  20  * may be used to endorse or promote products derived from this software without
  21  * specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  26  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef ARM_OCSD_MSG_LOGGER_H_INCLUDED
  36 #define ARM_OCSD_MSG_LOGGER_H_INCLUDED
  37
  38 #include <string>
  39 #include <fstream>
  40
  41 class ocsdMsgLogStrOutI
  42 {
  43 public:
  44         ocsdMsgLogStrOutI() {};
  45         virtual ~ocsdMsgLogStrOutI() {};
  46
  47         virtual void printOutStr(const std::string &outStr) = 0;
  48 };
  49
  50 class ocsdMsgLogger
  51 {
  52 public:
  53     ocsdMsgLogger();
  54     ~ocsdMsgLogger();
  55
  56     /** Typedef enum providing flags to define the output methods for the message logger.
  57     */
  58     typedef enum {
  59         OUT_NONE = 0,   /*!< No output from logger*/
  60         OUT_FILE = 1,   /*!< Output to file */
  61         OUT_STDERR = 2, /*!< Output to stderr */
  62         OUT_STDOUT = 4, /*!< Output to stdout */
  63                 OUT_STR_CB = 8  /*!< output to external string callback interface */
  64     } output_dest;
  65
  66     void setLogOpts(int logOpts); //!< set the output logging flags.
  67         const int getLogOpts() const  //! get the current output logging flags value.
  68     { return m_outFlags; };
  69
  70         void setLogFileName(const char *fileName);  //!< Set the output log filename, and enable logging to file.
  71         void setStrOutFn(ocsdMsgLogStrOutI *p_IstrOut); //!< Set the output log string callback and enable logging to callback.
  72
  73     void LogMsg(const std::string &msg); //!< Log a message to the current set output channels.
  74
  75     const bool isLogging() const; //!< true if logging active
  76
  77 private:
  78     int m_outFlags;
  79
  80     std::string m_logFileName;
  81     std::fstream m_out_file;
  82         ocsdMsgLogStrOutI *m_pOutStrI;
  83 };
  84
  85 #endif // ARM_OCSD_MSG_LOGGER_H_INCLUDED
  86
  87 /* End of File ocsd_msg_logger.h */