/data/gitorious.org/libyui/libyui-master/src/YUILog.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/


/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

  File:         YUILog.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YUILog_h

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

#include <iostream>
#include <string>

#include "ImplPtr.h"


//
// 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__ )

using std::endl;
using std::hex;
using std::dec;
using std::boolalpha;
using std::noboolalpha;
using std::string;

//
// ------ 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 string & logFileName );

    static 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 string basename( const string & fileNameWithPath );


private:
    YUILog();

    ~YUILog();

    //
    // Data
    //

    ImplPtr<YUILogPrivate> priv;
};


#define YUILog_h

#endif // YUILog_h