summaryrefslogtreecommitdiffstats
path: root/kdecore/kdebug.h
diff options
context:
space:
mode:
Diffstat (limited to 'kdecore/kdebug.h')
-rw-r--r--kdecore/kdebug.h665
1 files changed, 0 insertions, 665 deletions
diff --git a/kdecore/kdebug.h b/kdecore/kdebug.h
deleted file mode 100644
index 0a7d2546f..000000000
--- a/kdecore/kdebug.h
+++ /dev/null
@@ -1,665 +0,0 @@
-/* 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 "kdelibs_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;
-
-/**
- * \addtogroup kdebug Debug message generators
- * @{
- * KDE debug message streams let you and the user control just how many debug
- * messages you see.
- */
-
-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;
-/**
- * kdbgstream is a text stream that allows you to print debug messages.
- * Using the overloaded "<<" operator you can send messages. Usually
- * you do not create the kdbgstream yourself, but use kdDebug()
- * kdWarning(), kdError() or kdFatal to obtain one.
- *
- * Example:
- * \code
- * int i = 5;
- * kdDebug() << "The value of i is " << i << endl;
- * \endcode
- * @see kndbgstream
- */
-class KDECORE_EXPORT kdbgstream {
- public:
- /**
- * @internal
- */
- 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::tqfromLatin1(initialString)), area(_area), level(_level), print(_print) { }
- /// Copy constructor
- kdbgstream(kdbgstream &str);
- kdbgstream(const kdbgstream &str) :
- output(str.output), area(str.area), level(str.level), print(str.print) {}
- ~kdbgstream();
- /**
- * Prints the given value.
- * @param i the boolean to print (as "true" or "false")
- * @return this stream
- */
- kdbgstream &operator<<(bool i) {
- if (!print) return *this;
- output += TQString::tqfromLatin1(i ? "true" : "false");
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the short to print
- * @return this stream
- */
- kdbgstream &operator<<(short i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the unsigned short to print
- * @return this stream
- */
- kdbgstream &operator<<(unsigned short i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param ch the char to print
- * @return this stream
- */
- kdbgstream &operator<<(char ch);
- /**
- * Prints the given value.
- * @param ch the unsigned char to print
- * @return this stream
- */
- kdbgstream &operator<<(unsigned char ch) {
- return operator<<( static_cast<char>( ch ) );
- }
- /**
- * Prints the given value.
- * @param i the int to print
- * @return this stream
- */
- kdbgstream &operator<<(int i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the unsigned int to print
- * @return this stream
- */
- kdbgstream &operator<<(unsigned int i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the long to print
- * @return this stream
- */
- kdbgstream &operator<<(long i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the unsigned long to print
- * @return this stream
- */
- kdbgstream &operator<<(unsigned long i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the long long to print
- * @return this stream
- */
- kdbgstream &operator<<(TQ_LLONG i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
- /**
- * Prints the given value.
- * @param i the unsigned long long to print
- * @return this stream
- */
- kdbgstream &operator<<(TQ_ULLONG i) {
- if (!print) return *this;
- TQString tmp; tmp.setNum(i); output += tmp;
- return *this;
- }
-
- /**
- * Flushes the output.
- */
- void flush(); //AB: maybe this should be virtual! would save some trouble for some 3rd party projects
-
- /**
- * Prints the given value.
- * @param ch the char to print
- * @return this stream
- * @since 3.3
- */
- kdbgstream &operator<<(TQChar ch);
- /**
- * Prints the given value.
- * @param string the string to print
- * @return this stream
- */
- kdbgstream &operator<<(const TQString& string) {
- if (!print) return *this;
- output += string;
- if (output.tqat(output.length() -1 ) == (QChar)'\n')
- flush();
- return *this;
- }
- /**
- * Prints the given value.
- * @param string the string to print
- * @return this stream
- */
- kdbgstream &operator<<(const char *string) {
- if (!print) return *this;
- output += TQString::fromUtf8(string);
- if (output.tqat(output.length() - 1) == (QChar)'\n')
- flush();
- return *this;
- }
- /**
- * Prints the given value.
- * @param string the string to print
- * @return this stream
- */
- kdbgstream &operator<<(const TQCString& string) {
- *this << string.data();
- return *this;
- }
- /**
- * Prints the given value.
- * @param p a pointer to print (in number form)
- * @return this stream
- */
- kdbgstream& operator<<(const void * p) {
- form("%p", p);
- return *this;
- }
- /**
- * Invokes the given function.
- * @param f the function to invoke
- * @return the return value of @p f
- */
- kdbgstream& operator<<(KDBGFUNC f) {
- if (!print) return *this;
- return (*f)(*this);
- }
- /**
- * Prints the given value.
- * @param d the double to print
- * @return this stream
- */
- kdbgstream& operator<<(double d) {
- TQString tmp; tmp.setNum(d); output += tmp;
- return *this;
- }
- /**
- * Prints the string @p format which can contain
- * printf-style formatted values.
- * @param format the printf-style format
- * @return this stream
- */
- kdbgstream &form(const char *format, ...)
-#ifdef __GNUC__
- __attribute__ ( ( format ( printf, 2, 3 ) ) )
-#endif
- ;
-
- /** Operator to print out basic information about a TQWidget.
- * Output of class names only works if the class is tqmoc'ified.
- * @param widget the widget to print
- * @return this stream
- */
- kdbgstream& operator << (const TQWidget* widget);
- kdbgstream& operator << (TQWidget* widget); // KDE4 merge
-
- /**
- * Prints the given value.
- * @param dateTime the datetime to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQDateTime& dateTime );
-
- /**
- * Prints the given value.
- * @param date the date to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQDate& date );
-
- /**
- * Prints the given value.
- * @param time the time to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQTime& time );
-
- /**
- * Prints the given value.
- * @param point the point to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQPoint& point );
-
- /**
- * Prints the given value.
- * @param size the TQSize to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQSize& size );
-
- /**
- * Prints the given value.
- * @param rect the TQRect to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQRect& rect);
-
- /**
- * Prints the given value.
- * @param region the TQRegion to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQRegion& region);
-
- /**
- * Prints the given value.
- * @param url the url to print
- * @return this stream
- */
- kdbgstream& operator << ( const KURL& url );
-
- /**
- * Prints the given value.
- * @param list the stringlist to print
- * @return this stream
- */
- // ### KDE4: Remove in favor of template operator for TQValueList<T> below
- kdbgstream& operator << ( const TQStringList& list);
-
- /**
- * Prints the given value.
- * @param color the color to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQColor& color);
-
- /**
- * Prints the given value.
- * @param pen the pen to print
- * @return this stream
- * @since 3.2
- */
- kdbgstream& operator << ( const TQPen& pen );
-
- /**
- * Prints the given value.
- * @param brush the brush to print
- * @return this stream
- */
- kdbgstream& operator << ( const TQBrush& brush );
-
- /**
- * Prints the given value.
- * @param variant the variant to print
- * @return this stream
- * @since 3.3
- */
- kdbgstream& operator << ( const TQVariant& variant );
-
- /**
- * Prints the given value.
- * @param data the byte array to print
- * @return this stream
- * @since 3.3
- */
- kdbgstream& operator << ( const TQByteArray& data );
-
- /**
- * Prints the given value
- * @param list the list to print
- * @return this stream
- * @since 3.3
- */
- 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;
-}
-
-/**
- * \relates KGlobal
- * Prints an "\n".
- * @param s the debug stream to write to
- * @return the debug stream (@p s)
- */
-inline kdbgstream &endl( kdbgstream &s) { s << "\n"; return s; }
-
-/**
- * \relates KGlobal
- * Flushes the stream.
- * @param s the debug stream to write to
- * @return the debug stream (@p s)
- */
-inline kdbgstream &flush( kdbgstream &s) { s.flush(); return s; }
-
-KDECORE_EXPORT kdbgstream &perror( kdbgstream &s);
-
-/**
- * \relates KGlobal
- * kndbgstream is a dummy variant of kdbgstream. All functions do
- * nothing.
- * @see kndDebug()
- */
-class KDECORE_EXPORT kndbgstream {
- public:
- /// Default constructor.
- kndbgstream() {}
- ~kndbgstream() {}
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(short int ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(unsigned short int ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(char ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(unsigned char ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(int ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(unsigned int ) { return *this; }
- /**
- * Does nothing.
- */
- void flush() {}
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(TQChar) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(const TQString& ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(const TQCString& ) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream &operator<<(const char *) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(const void *) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(void *) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(double) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(long) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(unsigned long) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(TQ_LLONG) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(TQ_ULLONG) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator<<(KNDBGFUNC) { return *this; }
- /**
- * Does nothing.
- * @return this stream
- */
- kndbgstream& operator << (const TQWidget*) { return *this; }
- kndbgstream& operator << (TQWidget*) { return *this; } // KDE4 merge
- /**
- * Does nothing.
- * @return this stream
- */
- 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; }
-};
-
-/**
- * Does nothing.
- * @param s a stream
- * @return the given @p s
- */
-inline kndbgstream &endl( kndbgstream & s) { return s; }
-/**
- * Does nothing.
- * @param s a stream
- * @return the given @p s
- */
-inline kndbgstream &flush( kndbgstream & s) { return s; }
-inline kndbgstream &perror( kndbgstream & s) { return s; }
-
-/**
- * \relates KGlobal
- * Returns a debug stream. You can use it to print debug
- * information.
- * @param area an id to identify the output, 0 for default
- * @see kndDebug()
- */
-KDECORE_EXPORT kdbgstream kdDebug(int area = 0);
-KDECORE_EXPORT kdbgstream kdDebug(bool cond, int area = 0);
-/**
- * \relates KGlobal
- * Returns a backtrace.
- * @return a backtrace
- */
-KDECORE_EXPORT TQString kdBacktrace();
-/**
- * \relates KGlobal
- * Returns a backtrace.
- * @param levels the number of levels of the backtrace
- * @return a backtrace
- * @since 3.1
- */
-KDECORE_EXPORT TQString kdBacktrace(int levels);
-/**
- * Returns a dummy debug stream. The stream does not print anything.
- * @param area an id to identify the output, 0 for default
- * @see kdDebug()
- */
-inline kndbgstream kndDebug(int area = 0) { Q_UNUSED(area); return kndbgstream(); }
-inline kndbgstream kndDebug(bool , int = 0) { return kndbgstream(); }
-inline TQString kndBacktrace() { return TQString::null; }
-inline TQString kndBacktrace(int) { return TQString::null; }
-
-/**
- * \relates KGlobal
- * Returns a warning stream. You can use it to print warning
- * information.
- * @param area an id to identify the output, 0 for default
- */
-KDECORE_EXPORT kdbgstream kdWarning(int area = 0);
-KDECORE_EXPORT kdbgstream kdWarning(bool cond, int area = 0);
-/**
- * \relates KGlobal
- * Returns an error stream. You can use it to print error
- * information.
- * @param area an id to identify the output, 0 for default
- */
-KDECORE_EXPORT kdbgstream kdError(int area = 0);
-KDECORE_EXPORT kdbgstream kdError(bool cond, int area = 0);
-/**
- * \relates KGlobal
- * Returns a fatal error stream. You can use it to print fatal error
- * information.
- * @param area an id to identify the output, 0 for default
- */
-KDECORE_EXPORT kdbgstream kdFatal(int area = 0);
-KDECORE_EXPORT kdbgstream kdFatal(bool cond, int area = 0);
-
-/**
- * \relates KGlobal
- * Deletes the kdebugrc cache and therefore forces KDebug to reread the
- * config file
- */
-KDECORE_EXPORT void kdClearDebugConfig();
-
-/** @} */
-
-#ifdef NDEBUG
-#define kdDebug kndDebug
-#define kdBacktrace kndBacktrace
-#endif
-
-#endif
-