kdebug.h

/* This file is part of the KDE libraries
    Copyright (C) 1997 Matthias Kalle Dalheimer (kalle@kde.org)
                  2000-2002 Stephan Kulow (coolo@kde.org)
                  2002 Holger Freyther (freyther@kde.org)
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef _KDEBUG_H_
#define _KDEBUG_H_
 
#include <tqstring.h>
#include "tdelibs_export.h"
 
class TQWidget;
class TQDateTime;
class TQDate;
class TQTime;
class TQPoint;
class TQSize;
class TQRect;
class TQRegion;
class KURL;
class TQStringList;
class TQColor;
class TQPen;
class TQBrush;
class TQVariant;
template <class T>
class TQValueList;
 
class kdbgstream;
class kndbgstream;
 
typedef kdbgstream & (*KDBGFUNC)(kdbgstream &); // manipulator function
typedef kndbgstream & (*KNDBGFUNC)(kndbgstream &); // manipulator function
 
#ifdef __GNUC__
#define k_funcinfo "[" << __PRETTY_FUNCTION__ << "] "
#else
#define k_funcinfo "[" << __FILE__ << ":" << __LINE__ << "] "
#endif
 
#define k_lineinfo "[" << __FILE__ << ":" << __LINE__ << "] "
 
class kdbgstreamprivate;
class TDECORE_EXPORT kdbgstream {
 public:
    kdbgstream(unsigned int _area, unsigned int _level, bool _print = true) :
      area(_area), level(_level),  print(_print) { }
    kdbgstream(const char * initialString, unsigned int _area, unsigned int _level, bool _print = true) :
      output(TQString::fromLatin1(initialString)), area(_area), level(_level),  print(_print) { }
    kdbgstream(kdbgstream &str);
    kdbgstream(const kdbgstream &str) :
      output(str.output), area(str.area), level(str.level), print(str.print) {}
    ~kdbgstream();
    kdbgstream& operator<<(bool i)  {
    if (!print) return *this;
    output += TQString::fromLatin1(i ? "true" : "false");
    return *this;
    }
    kdbgstream& operator<<(short i)  {
    if (!print) return *this;
    TQString tmp; tmp.setNum(i); output += tmp;
    return *this;
    }
    kdbgstream& operator<<(unsigned short i) {
        if (!print) return *this;
        TQString tmp; tmp.setNum(i); output += tmp;
        return *this;
    }
    kdbgstream& operator<<(char ch);
    kdbgstream& operator<<(unsigned char ch) {
        return operator<<( static_cast<char>( ch ) );
    }
    kdbgstream& operator<<(int i)  {
    if (!print) return *this;
    TQString tmp; tmp.setNum(i); output += tmp;
    return *this;
    }
    kdbgstream& operator<<(unsigned int i) {
        if (!print) return *this;
        TQString tmp; tmp.setNum(i); output += tmp;
        return *this;
    }
    kdbgstream& operator<<(long i) {
        if (!print) return *this;
        TQString tmp; tmp.setNum(i); output += tmp;
        return *this;
    }
    kdbgstream& operator<<(unsigned long i) {
        if (!print) return *this;
        TQString tmp; tmp.setNum(i); output += tmp;
        return *this;
    }
    kdbgstream& operator<<(TQ_LLONG i) {
        if (!print) return *this;
        TQString tmp; tmp.setNum(i); output += tmp;
        return *this;
    }
    kdbgstream& operator<<(TQ_ULLONG i) {
        if (!print) return *this;
        TQString tmp; tmp.setNum(i); output += tmp;
        return *this;
    }
 
    void flush(); //AB: maybe this should be virtual! would save some trouble for some 3rd party projects
 
    kdbgstream& operator<<(TQChar ch);
    kdbgstream& operator<<(const TQString& string) {
    if (!print) return *this;
    output += string;
    if (output.at(output.length() -1 ) == (TQChar)'\n')
        flush();
    return *this;
    }
    kdbgstream& operator<<(const char *string) {
    if (!print) return *this;
    output += TQString::fromUtf8(string);
    if (output.at(output.length() - 1) == (TQChar)'\n')
        flush();
    return *this;
    }
    kdbgstream& operator<<(const TQCString& string) {
        *this << string.data();
        return *this;
    }
    kdbgstream& operator<<(const void * p) {
        form("%p", p);
        return *this;
    }
    kdbgstream& operator<<(KDBGFUNC f) {
    if (!print) return *this;
    return (*f)(*this);
    }
    kdbgstream& operator<<(double d) {
      TQString tmp; tmp.setNum(d); output += tmp;
      return *this;
    }
    kdbgstream& form(const char *format, ...)
#ifdef __GNUC__
      __attribute__ ( ( format ( printf, 2, 3 ) ) )
#endif
     ;
 
    kdbgstream& operator<< (const TQWidget* widget);
    kdbgstream& operator<< (TQWidget* widget); // KDE4 merge
 
    kdbgstream& operator<< ( const TQDateTime& dateTime );
 
    kdbgstream& operator<< ( const TQDate& date );
 
    kdbgstream& operator<< ( const TQTime& time );
 
    kdbgstream& operator<< ( const TQPoint& point );
 
    kdbgstream& operator<< ( const TQSize& size );
 
    kdbgstream& operator<< ( const TQRect& rect);
 
    kdbgstream& operator<< ( const TQRegion& region);
 
    kdbgstream& operator<< ( const KURL& url );
 
    // ### KDE4: Remove in favor of template operator for TQValueList<T> below
    kdbgstream& operator<< ( const TQStringList& list);
 
    kdbgstream& operator<< ( const TQColor& color);
 
    kdbgstream& operator<< ( const TQPen& pen );
 
    kdbgstream& operator<< ( const TQBrush& brush );
 
    kdbgstream& operator<< ( const TQVariant& variant );
 
    kdbgstream& operator<< ( const TQByteArray& data );
 
    template <class T>
    kdbgstream& operator<< ( const TQValueList<T> &list );
 
 private:
    TQString output;
    unsigned int area, level;
    bool print;
    kdbgstreamprivate* d;
};
 
template <class T>
kdbgstream& kdbgstream::operator<<( const TQValueList<T> &list )
{
    *this << "(";
    typename TQValueList<T>::ConstIterator it = list.begin();
    if ( !list.isEmpty() ) {
      *this << *it++;
    }
    for ( ; it != list.end(); ++it ) {
      *this << "," << *it;
    }
    *this << ")";
    return *this;
}
 
inline kdbgstream& endl( kdbgstream &s) { s << "\n"; return s; }
 
inline kdbgstream& flush( kdbgstream &s) { s.flush(); return s; }
 
TDECORE_EXPORT kdbgstream& perror( kdbgstream &s);
 
class TDECORE_EXPORT kndbgstream {
 public:
    kndbgstream() {}
    ~kndbgstream() {}
    kndbgstream& operator<<(short int )  { return *this; }
    kndbgstream& operator<<(unsigned short int )  { return *this; }
    kndbgstream& operator<<(char )  { return *this; }
    kndbgstream& operator<<(unsigned char )  { return *this; }
    kndbgstream& operator<<(int )  { return *this; }
    kndbgstream& operator<<(unsigned int )  { return *this; }
    void flush() {}
    kndbgstream& operator<<(TQChar)  { return *this; }
    kndbgstream& operator<<(const TQString& ) { return *this; }
    kndbgstream& operator<<(const TQCString& ) { return *this; }
    kndbgstream& operator<<(const char *) { return *this; }
    kndbgstream& operator<<(const void *) { return *this; }
    kndbgstream& operator<<(void *) { return *this; }
    kndbgstream& operator<<(double) { return *this; }
    kndbgstream& operator<<(long) { return *this; }
    kndbgstream& operator<<(unsigned long) { return *this; }
    kndbgstream& operator<<(TQ_LLONG) { return *this; }
    kndbgstream& operator<<(TQ_ULLONG) { return *this; }
    kndbgstream& operator<<(KNDBGFUNC) { return *this; }
    kndbgstream& operator<< (const TQWidget*) { return *this; }
    kndbgstream& operator<< (TQWidget*) { return *this; } // KDE4 merge
    kndbgstream& form(const char *, ...) { return *this; }
 
    kndbgstream& operator<<( const TQDateTime& ) { return *this; }
    kndbgstream& operator<<( const TQDate&     ) { return *this; }
    kndbgstream& operator<<( const TQTime&     ) { return *this; }
    kndbgstream& operator<<( const TQPoint & )  { return *this; }
    kndbgstream& operator<<( const TQSize & )  { return *this; }
    kndbgstream& operator<<( const TQRect & )  { return *this; }
    kndbgstream& operator<<( const TQRegion & ) { return *this; }
    kndbgstream& operator<<( const KURL & )  { return *this; }
    kndbgstream& operator<<( const TQStringList & ) { return *this; }
    kndbgstream& operator<<( const TQColor & ) { return *this; }
    kndbgstream& operator<<( const TQPen & ) { return *this; }
    kndbgstream& operator<<( const TQBrush & ) { return *this; }
    kndbgstream& operator<<( const TQVariant & ) { return *this; }
    kndbgstream& operator<<( const TQByteArray & ) { return *this; }
 
    template <class T>
    kndbgstream& operator<<( const TQValueList<T> & ) { return *this; }
};
 
inline kndbgstream& endl( kndbgstream & s) { return s; }
inline kndbgstream& flush( kndbgstream & s) { return s; }
inline kndbgstream& perror( kndbgstream & s) { return s; }
 
TDECORE_EXPORT kdbgstream kdDebug(int area = 0);
TDECORE_EXPORT kdbgstream kdDebug(bool cond, int area = 0);
TDECORE_EXPORT TQString kdBacktrace(int levels=-1);
TDECORE_EXPORT void kdBacktraceFD(int fd=2);
inline kndbgstream kndDebug(int area = 0) { Q_UNUSED(area); return kndbgstream(); }
inline kndbgstream kndDebug(bool , int  = 0) { return kndbgstream(); }
TDECORE_EXPORT kdbgstream kdWarning(int area = 0);
TDECORE_EXPORT kdbgstream kdWarning(bool cond, int area = 0);
TDECORE_EXPORT kdbgstream kdError(int area = 0);
TDECORE_EXPORT kdbgstream kdError(bool cond, int area = 0);
TDECORE_EXPORT kdbgstream kdFatal(int area = 0);
TDECORE_EXPORT kdbgstream kdFatal(bool cond, int area = 0);
 
TDECORE_EXPORT void kdClearDebugConfig();
 
#ifdef NDEBUG
#define kdDebug kndDebug
#endif
 
#endif