nmv-log-stream.h

Go to the documentation of this file.

/* -*- Mode: C++; indent-tabs-mode:nil; c-basic-offset: 4-*- */
 
/*Copyright (c) 2005-2006 Dodji Seketeli
 *
 * 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 __NMV_LOG_STREAM_H__
#define __NMV_LOG_STREAM_H__
#include <string>
#include "nmv-api-macros.h"
#include "nmv-ustring.h"
#include "nmv-safe-ptr.h"
#include "nmv-api-macros.h"
 
#ifndef NMV_DEFAULT_DOMAIN
#define NMV_DEFAULT_DOMAIN __extension__        \
    ({                                          \
        const char* path = __FILE__;            \
        Glib::path_get_basename (path);         \
    })
#endif
 
#ifndef NMV_GENERAL_DOMAIN
#define NMV_GENERAL_DOMAIN "general-domain"
#endif
 
using std::string;
namespace nemiver {
namespace common {
 
class NEMIVER_API LogStream
{
    friend LogStream& timestamp (LogStream &);
    friend LogStream& flush (LogStream &);
    friend LogStream& endl (LogStream &);
    struct Priv;
    SafePtr<Priv> m_priv;
 
    //forbid copy/assignation
    LogStream (LogStream const&);
    LogStream& operator= (LogStream const&);
 
protected:
 
public:
 
    enum StreamType {
        FILE_STREAM = 1,
        COUT_STREAM = 1 >> 1,
        CERR_STREAM = 1 >> 2,
        RFU0,//reserved for future usage
        RFU1,
        RFU2,
    };
 
    enum LogLevel {
        LOG_LEVEL_NORMAL=0,
        LOG_LEVEL_VERBOSE
    };
 
    static void set_stream_type (enum StreamType a_type);
 
    static enum StreamType get_stream_type ();
 
    static void set_stream_file_path (const char* a_file_path, long a_len=-1);
 
    static const char* get_stream_file_path ();
 
    static void set_log_level_filter (enum LogLevel a_level);
 
    static void set_log_domain_filter (const char* a_domain, long a_len=-1);
 
    static void activate (bool a_activate);
 
    static bool is_active ();
 
    static LogStream& default_log_stream ();
 
 
    LogStream (enum LogLevel a_level=LOG_LEVEL_NORMAL,
               const string &a_default_domain=NMV_GENERAL_DOMAIN);
 
    virtual ~LogStream ();
 
    void enable_domain (const string &a_domain,
                        bool a_do_enable=true);
 
    bool is_domain_enabled (const string &a_domain);
 
    LogStream& write (const char *a_buf,
                      long a_buflen =-1,
                      const string &a_domain=NMV_GENERAL_DOMAIN);
 
    LogStream& write (const Glib::ustring &a_msg,
                      const string &a_domain=NMV_GENERAL_DOMAIN);
 
    LogStream& write (int a_msg,
                      const string &a_domain=NMV_GENERAL_DOMAIN);
 
    LogStream& write (double a_msg,
                      const string &a_domain=NMV_GENERAL_DOMAIN);
 
    LogStream& write (char a_msg,
                      const string &a_domain=NMV_GENERAL_DOMAIN);
 
    void push_domain (const string &a_domain);
 
    void pop_domain ();
 
    LogStream& operator<< (const char* a_c_string);
 
    LogStream& operator<< (const std::string &a_string);
 
    LogStream& operator<< (const Glib::ustring &a_string);
 
    LogStream& operator<< (int an_int);
 
    LogStream& operator<< (double a_double);
 
    LogStream& operator<< (char a_char);
 
    LogStream& operator<< (LogStream& (*a_manipulator) (LogStream&));
 
    friend LogStream& level_normal (LogStream &a_stream);
 
    friend LogStream& level_verbose (LogStream &a_stream);
 
};//end class LogStream
 
NEMIVER_API LogStream& timestamp (LogStream&);
 
NEMIVER_API LogStream& flush (LogStream &);
 
NEMIVER_API LogStream& endl (LogStream &);
 
NEMIVER_API LogStream& level_normal (LogStream &);
 
NEMIVER_API LogStream& level_verbose (LogStream &);
 
}//end namespace common
}//end namespace nemiver
 
#endif //__NMV_LOG_STREAM_H__