introduce numeric constants for the odebug output destinations

2 files changed, 14 insertions, 7 deletions

diff --git a/libopie2/opiecore/odebug.cpp b/libopie2/opiecore/odebug.cpp
index 3bffdd0..d8dfe26 100644
--- a/libopie2/opiecore/odebug.cpp
+++ b/libopie2/opiecore/odebug.cpp
@@ -52,203 +52,203 @@
 #include <qsocketdevice.h>
 
 /* UNIX */
 
 #include <stdlib.h>     // abort
 #include <unistd.h>     // getpid
 #include <stdarg.h>     // vararg stuff
 #include <ctype.h>      // isprint
 #include <syslog.h>
 #include <errno.h>
 #include <string.h>
 
 #ifndef OPIE_NO_BACKTRACE
 #include <execinfo.h>
 #endif
 
 namespace Opie {
 namespace Core {
 namespace Internal {
 /*======================================================================================
  * debug levels
  *======================================================================================*/
 
 enum DebugLevels {
     ODEBUG_INFO     = 0,
     ODEBUG_WARN     = 1,
     ODEBUG_ERROR    = 2,
     ODEBUG_FATAL    = 3
 };
 
 /*======================================================================================
  * oDebug private data
  *======================================================================================*/
 
 /*======================================================================================
  * the main debug function
  *======================================================================================*/
 
 
 
 struct  DebugBackend {
     DebugBackend() : m_opened( false ), m_file( 0 ) ,m_port( -1 ),m_sock( 0 ) {
         m_outp = OGlobalSettings::debugMode();
     }
     ~DebugBackend() {
         delete m_file;
         delete m_sock;
     }
     void debug( unsigned short level, unsigned int, const QString& data );
 
 private:
     void debugFile( const QString&, const QString& data );
     void debugMsgB( const QString&, const QString& data );
     void debugShel( const QString&, const QString& data );
     void debugSysl( int, const QString& );
     void debugSock( const QString&, const QString& data );
     QCString line( const QString&, const QString& data );
     bool m_opened : 1;
     QFile *m_file;
     QHostAddress m_addr;
     int m_port;
     QSocketDevice *m_sock;
     short m_outp;
 };
 
 void DebugBackend::debug(unsigned short level, unsigned int, const QString& data) {
     //qDebug( "oDebugBackend: Level=%d, Area=%d, Data=%s", level, area, data );
 
     // ML: OPIE doesn't use areacodes at the moment. See the KDE debug classes for an
     // ML: example use. I think it's not necessary to implement such a strategy here.
     // ML: Comments?
 
     int priority = 0;
     QString caption;
     QString lev;
     switch( level )
     {
         case ODEBUG_INFO: lev = "(Info)"; caption = "Info"; priority = LOG_INFO; break;
         case ODEBUG_WARN: lev = "(Warn)"; caption = "Warning"; priority = LOG_WARNING; break;
         case ODEBUG_FATAL: lev = "(Fatal)"; caption = "Fatal Error"; priority = LOG_CRIT; break;
         default: qDebug( "oDebugBackend: Warning: Unknown debug level! - defaulting to ODEBUG_ERROR." );
         case ODEBUG_ERROR: lev = "(Error)"; caption = "Error"; priority = LOG_ERR; break;
     }
 
     if (!oApp && (m_outp == 1)) {
         qDebug( "oDebugBackend: Warning: no oapplication object - can't use MsgBox" );
         m_outp = 2; // need an application object to use MsgBox
     }
 
     // gcc 2.9x is dumb and sucks... can you hear it?
     //QString areaName = (oApp) ? oApp->appName() : "<unknown>";
     QString areaName;
     if ( oApp ) areaName = oApp->appName();
     else areaName = "<unknown>";
 
     switch( m_outp ) {
-    case -1: // ignore
+    case ODEBUG_IGNORE:
         return;
-    case 0: // File
+    case ODEBUG_FILE:
         return debugFile( areaName, data );
-    case 1: // Message Box
+    case ODEBUG_MSGBOX:
         return debugMsgB( areaName, data );
-    case 2:
+    case ODEBUG_STDERR:
         return debugShel( areaName,data );
-    case 3: // syslog
+    case ODEBUG_SYSLOG:
         return debugSysl( priority, data );
-    case 4: // socket
+    case ODEBUG_SOCKET:
         return debugSock( areaName, data );
     }
 }
 
 inline void DebugBackend::debugFile(const QString& area, const QString& data) {
     /* something went wrong with the file don't bother.. */
     if ( m_opened && !m_file )
         return;
     else if ( !m_opened ) {
         m_opened = true;
         m_file = new QFile( OGlobalSettings::debugOutput() );
         if (!m_file->open( IO_WriteOnly | IO_Append ) ) {
             delete m_file; m_file = 0;
             qDebug( "ODebug: can't write to file '%s' (%s)", (const char*)OGlobalSettings::debugOutput(),
                     strerror(errno) );
             return;
         }
     }
 
     /* go to end of file */
     m_file->at( m_file->size() );
     QCString li = line( area, data );
     m_file->writeBlock(li.data(), li.length() );
 }
 
 void DebugBackend::debugMsgB( const QString& area, const QString& data ) {
     QMessageBox::warning( 0l, "("+area+")", data, ("Ok") );
 }
 
 void DebugBackend::debugShel( const QString& are, const QString& data ) {
     FILE *output = stderr;
     fprintf( output, "%s: %s", are.local8Bit().data(),
              data.local8Bit().data() );
 }
 
 void DebugBackend::debugSysl( int prio, const QString& data ) {
     ::syslog( prio, "%s", data.local8Bit().data() );
 }
 
 void DebugBackend::debugSock( const QString& are, const QString& data ) {
     if ( m_opened && !m_sock  )
         return;
     else if ( !m_opened ){
         m_opened = true;
         QString destination = OGlobalSettings::debugOutput();
         if ( destination && destination.find(":") != -1 ) {
             QString host = destination.left( destination.find(":") );
             m_port = destination.right( destination.length()-host.length()-1 ).toInt();
             m_addr.setAddress( host );
             m_sock = new QSocketDevice( QSocketDevice::Datagram );
         }else{
             m_sock = 0;
             return;
         }
     }
 
     QCString li = line( are, data );
     int result = m_sock->writeBlock(li.data(), li.length(), m_addr, m_port );
     if ( result == -1 ) {
          qDebug( "ODebug: can't send to address '"+ m_addr.toString() +":%d' (%s)",
                  m_port, strerror(errno) );
     }
 }
 
 QCString DebugBackend::line( const QString& area, const QString& data ) {
     QString str = area +":"+data;
     return str.local8Bit();
 }
 
 static  DebugBackend *backEnd = 0;
 }
 static void clean_up_routine() {
     qWarning( "Clean up Debug" );
     delete Internal::backEnd;
     Internal::backEnd = 0;
 }
 /*======================================================================================
  * odbgstream
  *======================================================================================*/
 
 odbgstream& perror( odbgstream &s)
 {
     return s << QString::fromLocal8Bit(strerror(errno));
 }
 
 odbgstream odDebug(int area)
 {
     return odbgstream(area, Internal::ODEBUG_INFO);
 }
 odbgstream odDebug(bool cond, int area)
 {
     if (cond) return odbgstream(area, Internal::ODEBUG_INFO);
     else return odbgstream(0, 0, false);
 }
 
 odbgstream odError(int area)
diff --git a/libopie2/opiecore/odebug.h b/libopie2/opiecore/odebug.h
index 3851a41..21a6c26 100644
--- a/libopie2/opiecore/odebug.h
+++ b/libopie2/opiecore/odebug.h
@@ -1,165 +1,172 @@
 /*
                              This file is part of the Opie Project
                              (C) 2003 Michael 'Mickey' Lauer (mickey@tm.informatik.uni-frankfurt.de)
                              Inspired by the KDE debug classes, which are
                              (C) 1997 Matthias Kalle Dalheimer (kalle@kde.org)
                              (C) 2002 Holger Freyther (freyther@kde.org)
               =.
             .=l.
            .>+-=
  _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=          redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
 .="- .-=="i,     .._         License as published by the Free Software
  - .   .-<_>     .<>         Foundation; either version 2 of the License,
      ._= =}       :          or (at your option) any later version.
     .%`+i>       _;_.
     .i_,=:_.      -<s.       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
 ..}^=.=       =       ;      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., 59 Temple Place - Suite 330,
                              Boston, MA 02111-1307, USA.
 */
 
 #ifndef ODEBUG_H
 #define ODEBUG_H
 
 #include <qstring.h>
 
 class QWidget;
 class QDateTime;
 class QDate;
 class QTime;
 class QPoint;
 class QSize;
 class QRect;
 class QRegion;
 class QStringList;
 class QColor;
 class QBrush;
 
 namespace Opie {
 namespace Core {
 
 class odbgstream;
 class ondbgstream;
 
 #ifdef __GNUC__
 #define o_funcinfo "[" << __PRETTY_FUNCTION__ << "] "
 #else
 #define o_funcinfo "[" << __FILE__ << ":" << __LINE__ << "] "
 #endif
 
 #define o_lineinfo "[" << __FILE__ << ":" << __LINE__ << "] "
 
 #define owarn Opie::Core::odWarning()
 #define oerr Opie::Core::odError()
 #define odebug Opie::Core::odDebug()
 #define ofatal Opie::Core::odFatal()
 #define oendl "\n"
 
+const int ODEBUG_IGNORE = -1;
+const int ODEBUG_FILE   = 0;
+const int ODEBUG_MSGBOX = 1;
+const int ODEBUG_STDERR = 2;
+const int ODEBUG_SYSLOG = 3;
+const int ODEBUG_SOCKET = 4;
+
 class odbgstreamprivate;
 /**
  * odbgstream 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 odbgstream yourself, but use @ref odDebug() (odebug)
  * @ref odWarning() (owarn), @ref odError() (oerr) or @ref odFatal (ofatal) to obtain one.
  *
  * Example:
  * <pre>
  *    int i = 5;
  *    odebug << "The value of i is " << i << oendl;
  * </pre>
  * @see odbgstream
  */
 
 /*======================================================================================
  * odbgstream
  *======================================================================================*/
 
 class odbgstream
 {
   public:
   /**
    * @internal
    */
     odbgstream(unsigned int _area, unsigned int _level, bool _print = true);
     odbgstream(const char * initialString, unsigned int _area, unsigned int _level, bool _print = true);
     odbgstream(odbgstream &str);
     odbgstream(const odbgstream &str);
     virtual ~odbgstream();
 
     /**
      * Prints the given value.
      * @param i the boolean to print (as "true" or "false")
      * @return this stream
      */
     odbgstream &operator<<(bool i);
     /**
      * Prints the given value.
      * @param i the short to print
      * @return this stream
      */
     odbgstream &operator<<(short i);
     /**
      * Prints the given value.
      * @param i the unsigned short to print
      * @return this stream
      */
     odbgstream &operator<<(unsigned short i);
     /**
      * Prints the given value.
      * @param i the char to print
      * @return this stream
      */
     odbgstream &operator<<(char i);
     /**
      * Prints the given value.
      * @param i the unsigned char to print
      * @return this stream
      */
     odbgstream &operator<<(unsigned char i);
     /**
      * Prints the given value.
      * @param i the int to print
      * @return this stream
      */
     odbgstream &operator<<(int i);
     /**
      * Prints the given value.
      * @param i the unsigned int to print
      * @return this stream
      */
     odbgstream &operator<<(unsigned int i);
     /**
      * Prints the given value.
      * @param i the long to print
      * @return this stream
      */
     odbgstream &operator<<(long i);
     /**
      * Prints the given value.
      * @param i the unsigned long to print
      * @return this stream
      */
     odbgstream &operator<<(unsigned long i);
     /**
      * Flushes the output.
      */
     virtual void flush();
     /**
      * Prints the given value.
      * @param string the string to print
      * @return this stream
      */
     odbgstream &operator<<(const QString& string);
     /**
@@ -304,181 +311,181 @@ class ondbgstream {
     ~ondbgstream() {}
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(short int )  { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(unsigned short int )  { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(char )  { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(unsigned char )  { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(int )  { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(unsigned int )  { return *this; }
     /**
      * Does nothing.
      */
     void flush() {}
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(const QString& ) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(const QCString& ) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &operator<<(const char *) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream& operator<<(const void *) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream& operator<<(void *) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream& operator<<(double) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream& operator<<(long) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream& operator<<(unsigned long) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream& operator << (QWidget*) { return *this; }
     /**
      * Does nothing.
      * @return this stream
      */
     ondbgstream &form(const char *, ...) { return *this; }
 
     ondbgstream& operator<<( const QDateTime& ) { return *this; }
     ondbgstream& operator<<( const QDate&     ) { return *this; }
     ondbgstream& operator<<( const QTime&     ) { return *this; }
     ondbgstream& operator<<( const QPoint & )  { return *this; }
     ondbgstream& operator<<( const QSize & )  { return *this; }
     ondbgstream& operator<<( const QRect & )  { return *this; }
     ondbgstream& operator<<( const QRegion & ) { return *this; }
     ondbgstream& operator<<( const QStringList & ) { return *this; }
     ondbgstream& operator<<( const QColor & ) { return *this; }
     ondbgstream& operator<<( const QBrush & ) { return *this; }
-    
+
 private:
     class Private;
     Private *d;
 };
 
 /*======================================================================================
  * related functions
  *======================================================================================*/
 
 /**
  * Does nothing.
  * @param a stream
  * @return the given @p s
  */
 inline ondbgstream& endl( ondbgstream & s) { return s; }
 /**
  * Does nothing.
  * @param a stream
  * @return the given @p s
  */
 inline ondbgstream& flush( ondbgstream & s) { return s; }
 inline ondbgstream& perror( ondbgstream & s) { return s; }
 
 /**
  * Returns a debug stream. You can use it to print debug
  * information.
  * @param area an id to identify the output, 0 for default
  */
 odbgstream odDebug(int area = 0);
 odbgstream odDebug(bool cond, int area = 0);
 /**
  * Returns a backtrace.
  * @param levels the number of levels (-1 for unlimited) of the backtrace
  * @return a backtrace
  */
 QString odBacktrace(int levels = -1);
 /**
  * Returns a dummy debug stream. The stream does not print anything.
  * @param area an id to identify the output, 0 for default
  * @see odDebug()
  */
 inline ondbgstream ondDebug(int = 0) { return ondbgstream(); }
 inline ondbgstream ondDebug(bool , int  = 0) { return ondbgstream(); }
 inline QString ondBacktrace() { return QString::null; }
 inline QString ondBacktrace(int) { return QString::null; }
 
 /**
  * Returns a warning stream. You can use it to print warning
  * information.
  * @param area an id to identify the output, 0 for default
  */
 odbgstream odWarning(int area = 0);
 odbgstream odWarning(bool cond, int area = 0);
 /**
  * Returns an error stream. You can use it to print error
  * information.
  * @param area an id to identify the output, 0 for default
  */
 odbgstream odError(int area = 0);
 odbgstream odError(bool cond, int area = 0);
 /**
  * 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
  */
 odbgstream odFatal(int area = 0);
 odbgstream odFatal(bool cond, int area = 0);
 
 /**
  * Deletes the odebugrc cache and therefore forces KDebug to reread the
  * config file
  */
 void odClearDebugConfig();
 
 #ifdef OPIE_NO_DEBUG
 #define odDebug ondDebug
 #define odBacktrace ondBacktrace
 #endif
 
 }
 }
 
 #endif