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