Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 161 insertions, 0 deletions

diff --git a/kmail/filterlog.h b/kmail/filterlog.h
new file mode 100644
index 00000000..81455679
--- /dev/null
+++ b/kmail/filterlog.h
@@ -0,0 +1,161 @@
+/*
+    This file is part of KMail.
+    Copyright (c) 2003 Andreas Gungl <a.gungl@gmx.de>
+
+    KMail is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License, version 2, as
+    published by the Free Software Foundation.
+
+    KMail 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
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of this program with any edition of
+    the Qt library by Trolltech AS, Norway (or with modified versions
+    of Qt that use the same license as Qt), and distribute linked
+    combinations including the two.  You must obey the GNU General
+    Public License in all respects for all of the code used other than
+    Qt.  If you modify this file, you may extend this exception to
+    your version of the file, but you are not obligated to do so.  If
+    you do not wish to do so, delete this exception statement from
+    your version.
+*/
+#ifndef KMAIL_FILTERLOG_H
+#define KMAIL_FILTERLOG_H
+
+#include <qobject.h>
+#include <qstringlist.h>
+#include <qstylesheet.h>
+
+namespace KMail {
+
+  /**
+    @short KMail Filter Log Collector.
+    @author Andreas Gungl <a.gungl@gmx.de>
+
+    The filter log helps to collect log information about the
+    filter process in KMail. It's implemented as singleton,
+    so it's easy to direct pieces of information to a unique
+    instance.
+    It's possible to activate / deactivate logging. All
+    collected log information can get thrown away, the
+    next added log entry is the first one until another 
+    clearing.
+    A signal is emitted whenever a new logentry is added,
+    when the log was cleared or any log state was changed.
+  */
+  class FilterLog : public QObject
+  {
+    Q_OBJECT
+
+    public:
+      /** access to the singleton instance */
+      static FilterLog * instance();
+      
+      /** log data types */
+      enum ContentType 
+      { 
+        meta          = 1, 
+        patternDesc   = 2, 
+        ruleResult    = 4, 
+        patternResult = 8, 
+        appliedAction = 16
+      };
+      
+      
+      /** check the logging state */
+      bool isLogging() { return mLogging; };
+      /** set the logging state */
+      void setLogging( bool active )
+      {
+        mLogging = active; 
+        emit logStateChanged();
+      };
+      
+      
+      /** control the size of the log */
+      void setMaxLogSize( long size = -1 );
+      long getMaxLogSize() { return mMaxLogSize; };
+      
+      
+      /** add/remove a content type to the set of logged ones */
+      void setContentTypeEnabled( ContentType contentType, bool b )
+      { 
+        if ( b )
+          mAllowedTypes |= contentType;
+        else
+          mAllowedTypes &= ~contentType;
+        emit logStateChanged();
+      };
+
+      /** check a content type for inclusion in the set of logged ones */
+      bool isContentTypeEnabled( ContentType contentType )
+      { 
+        return mAllowedTypes & contentType; 
+      };
+
+      
+      /** add a log entry */
+      void add( QString logEntry, ContentType contentType );
+      /** add a separating line in the log */
+      void addSeparator() { add( "------------------------------", meta ); };
+      /** discard collected log data */
+      void clear() 
+      {
+        mLogEntries.clear(); 
+        mCurrentLogSize = 0;
+        emit logShrinked();
+      };
+      
+      
+      /** get access to the log entries */
+      const QStringList & getLogEntries() { return mLogEntries; };
+      /** dump the log - for testing purposes */
+      void dump();
+      /** save the log to a file - returns true if okay */
+      bool saveToFile( QString fileName );
+      
+      /** destructor */
+      virtual ~FilterLog();
+      
+      static QString recode( const QString & plain ) { return QStyleSheet::escape(plain); };
+      
+    signals:
+      void logEntryAdded( QString );
+      void logShrinked();
+      void logStateChanged();
+
+    protected:
+      /** Non-public constructor needed by the singleton implementation */
+      FilterLog();
+      
+      /** The list contains the single log pieces */
+      QStringList mLogEntries;
+      
+      /** the log status */
+      bool mLogging;
+      
+      /** max size for kept log items, when reached 
+          the last recently added items are discarded
+          -1 means unlimited */
+      long mMaxLogSize;
+      long mCurrentLogSize;
+      
+      /** types currently allowed to be legged */
+      int mAllowedTypes;
+      
+      void checkLogSize();
+      
+    private:
+      static FilterLog * mSelf;
+  };
+
+} // namespace KMail
+
+#endif // KMAIL_FILTERLOG_H