YUILog.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YUILog.h

  Author:       Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YUILog_h

#ifndef YUILogComponent
#error Missing #define YUILogComponent "myComponent" before #include "YUILog.h"
#endif

#include <iostream>
#include <string>

#include "ImplPtr.h"

using std::endl;


//
// UI Logging: Macros for Application use.
//
// They all return a std::ostream &  for use with operator<<().
// #define YUILogComponent before including this header file
// to identify what subsystem ("my-ui" etc.) this log line belongs to.
//
//    #define YUILogComponent "myComponent"
//    #include <YUILog.h>
//
//    ...
//    yuiDebug() << "Creating widget" << widget << endl;
//    yuiError() << "No widget with ID " << id << endl;
//
// Unless the underlying logger function handles this differently,
// Milestone, Warning and Error are always logged, Debug only when enabled.
//

#define yuiDebug()  YUILog::debug    ( YUILogComponent, __FILE__, __LINE__, __FUNCTION__ )
#define yuiMilestone()  YUILog::milestone( YUILogComponent, __FILE__, __LINE__, __FUNCTION__ )
#define yuiWarning()    YUILog::warning  ( YUILogComponent, __FILE__, __LINE__, __FUNCTION__ )
#define yuiError()  YUILog::error    ( YUILogComponent, __FILE__, __LINE__, __FUNCTION__ )


//
// ------ End of user relevant part ------
//



class YUILogPrivate;

enum YUILogLevel_t
{
    YUI_LOG_DEBUG     = 0,
    YUI_LOG_MILESTONE,
    YUI_LOG_WARNING,
    YUI_LOG_ERROR
};


typedef void (*YUILoggerFunction)( YUILogLevel_t,   // logLevel
                   const char *,    // logComponent
                   const char *,    // sourceFileName
                   int,         // sourceLineNo
                   const char *,    // sourceFunctionName
                   const char * );  // message

typedef void (*YUIEnableDebugLoggingFunction)( bool );
typedef bool (*YUIDebugLoggingEnabledFunction)();


class YUILog
{
public:

    static std::ostream & debug    ( const char * logComponent, const char * sourceFileName, int lineNo, const char * functionName );
    static std::ostream & milestone( const char * logComponent, const char * sourceFileName, int lineNo, const char * functionName );
    static std::ostream & warning  ( const char * logComponent, const char * sourceFileName, int lineNo, const char * functionName );
    static std::ostream & error    ( const char * logComponent, const char * sourceFileName, int lineNo, const char * functionName );

    std::ostream & log( YUILogLevel_t   logLevel,
            const char *    logComponent,
            const char *    sourceFileName,
            int         lineNo,
            const char *    functionName );

    static YUILog * instance();

    static void enableDebugLogging( bool debugLogging = true );

    static bool debugLoggingEnabled();

    static bool setLogFileName( const std::string & logFileName );

    static std::string logFileName();

    static void setLoggerFunction( YUILoggerFunction loggerFunction );

    static YUILoggerFunction loggerFunction( bool returnStdLogger = false );

    static void setEnableDebugLoggingHooks( YUIEnableDebugLoggingFunction  enableFunction,
                        YUIDebugLoggingEnabledFunction isEnabledFunction );

    static YUIEnableDebugLoggingFunction  enableDebugLoggingHook();

    static YUIDebugLoggingEnabledFunction debugLoggingEnabledHook();

    static std::string basename( const std::string & fileNameWithPath );


private:
    YUILog();

    ~YUILog();

    //
    // Data
    //

    ImplPtr<YUILogPrivate> priv;
};


#define YUILog_h

#endif // YUILog_h