Added new generic sorted for the databook backends. Needed an sortedvector

to do this job, which is now added to private classes..

10 files changed, 308 insertions, 6 deletions

diff --git a/libopie2/opiepim/ChangeLog b/libopie2/opiepim/ChangeLog
index 320b189..e94fa59 100644
--- a/libopie2/opiepim/ChangeLog
+++ b/libopie2/opiepim/ChangeLog
@@ -1,12 +1,15 @@
+2005-01-16 Stefan Eilers <stefan@eilers-online.net>
+	* Added new OPimEventSortVector class, improved OPimSortVector
+	* OPimAccessBackend now supports generic sorting.
 2005-01-03 Stefan Eilers <stefan@eilers-online.net>
 	* Fixing bug in API documentation
 	* Moving hasQuerySettings() and querySettings() to OPimAccessTemplate to be available for all frontends
 2004-12-28  Stefan Eilers <stefan@eilers-online.net>
 	* Make improved query by example accessable via frontend
 	* Some API documentation improvement
 	* Cleanup of backend api..
 	* Fixing bug #1501
 2004-11-23  Stefan Eilers <stefan@eilers-online.net>
 	* Implement fast and full featured version of sorted() for addressbook
 	* Implement generic queryByExample for all Addressboook backends. It allows incremental search.
 	* Update of API Documentation
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend.cpp b/libopie2/opiepim/backend/ocontactaccessbackend.cpp
index b4fdd46..c09427c 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend.cpp
+++ b/libopie2/opiepim/backend/ocontactaccessbackend.cpp
@@ -1,15 +1,16 @@
 /*
                              This file is part of the Opie Project
-                             Copyright (C) 2004 Holger Freyther <freyther@handhelds.org>
+                             Copyright (C) Holger Freyther <freyther@handhelds.org>
+			     Copyright (C) Stefan Eilers <stefan@eilers-online.net> 
               =.             Copyright (C) The Opie Team <opie-devel@handhelds.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;
@@ -228,25 +229,25 @@ bool OPimContactAccessBackend::hasQuerySettings (uint querySettings) const
         return ( true );
     case OPimContactAccess::ExactMatch:
         return ( true );
     case 0: // one of the upper removed bits were set..
         return ( true );
     default:
         return ( false );
     }
 }
 
 
 UIDArray OPimContactAccessBackend::sorted( const UIDArray& ar, bool asc, int sortOrder,
-                                  int filter, const QArray<int>& categories)const {
+                                  int filter, const QArray<int>& categories )const {
     odebug << "Using Unaccelerated OPimContactAccessBackend sorted Implementation" << oendl;
 
     Internal::OPimContactSortVector vector(ar.count(), asc, sortOrder );
 
     int item = 0;
     uint cat_count = categories.count();
     uint eve_count = ar.count();
     bool bCat = filter  & OPimContactAccess::FilterCategory ? true : false;
     bool catPassed = false;
     int cat;
 
     for ( uint i = 0; i < eve_count; ++i ) {
diff --git a/libopie2/opiepim/backend/ocontactaccessbackend.h b/libopie2/opiepim/backend/ocontactaccessbackend.h
index 27d70ab..d5c463b 100644
--- a/libopie2/opiepim/backend/ocontactaccessbackend.h
+++ b/libopie2/opiepim/backend/ocontactaccessbackend.h
@@ -1,15 +1,16 @@
 /*
                              This file is part of the Opie Project
-                             Copyright (C) The Main Author <main-author@whereever.org>
+                             Copyright (C) Holger Freyther <freyther@handhelds.org>
+                             Copyright (C) Stefan Eilers <stefan@eilers-online.net>
               =.             Copyright (C) The Opie Team <opie-devel@handhelds.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;
diff --git a/libopie2/opiepim/backend/odatebookaccessbackend.cpp b/libopie2/opiepim/backend/odatebookaccessbackend.cpp
index e44912a..6da0170 100644
--- a/libopie2/opiepim/backend/odatebookaccessbackend.cpp
+++ b/libopie2/opiepim/backend/odatebookaccessbackend.cpp
@@ -19,27 +19,29 @@
 ..}^=.=       =       ;      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.
 */
 #include <qtl.h>
 
+#include <opie2/odebug.h>
 #include <opie2/opimrecurrence.h>
-
+#include <opie2/odatebookaccess.h>
 #include <opie2/odatebookaccessbackend.h>
+#include <opie2/private/opimeventsortvector.h>
 
 using namespace Opie;
 
 namespace {
 /* a small helper to get all NonRepeating events for a range of time */
 void events( OPimBackendOccurrence::List& tmpList,
              const OPimEvent::ValueList& events,
              const QDate& from, const QDate& to ) {
     QDateTime dtStart, dtEnd;
 
     for ( OPimEvent::ValueList::ConstIterator it = events.begin(); it != events.end(); ++it ) {
         dtStart = (*it).startDateTime();
@@ -135,26 +137,76 @@ bool ODateBookAccessBackend::hasQuerySettings (uint querySettings) const
 	return false;
 }
 
 
 
 UIDArray ODateBookAccessBackend::queryByExample( const UIDArray& uidlist, const OPimEvent&, int settings,
                                                  const QDateTime& d )const 
 {
 	qDebug( "Accessing ODateBookAccessBackend::queryByExample() which is not implemented!" );
     return UIDArray();
 }
 
-UIDArray ODateBookAccessBackend::sorted( const UIDArray&, bool asc, int, int, const QArray<int>& )const {
-    return UIDArray();
+UIDArray ODateBookAccessBackend::sorted( const UIDArray& ar, bool asc, int sortOrder, int filter, const QArray<int>& categories )const {
+    odebug << "Using Unaccelerated ODateBookAccessBackend sorted Implementation" << oendl;
+
+    Internal::OPimEventSortVector vector( ar.count(), asc, sortOrder );
+    int item = 0;
+
+    for ( uint i = 0; i < ar.count(); ++i ){
+	    OPimEvent event = find( ar[i], ar, i, Frontend::Forward );
+	    if ( event.isEmpty() ) 
+		    continue;
+
+	    bool catPassed = true;
+	    if ( filter & ODateBookAccess::FilterCategory ){
+		    catPassed = false;
+		    // Filter Categories
+		    for ( uint cat_idx = 0; cat_idx < categories.count(); ++cat_idx ){
+			    int cat = categories[cat_idx];
+			    if ( cat == -1 || cat == 0 ){
+				    // Unfiled. Check next category if list is not empty.
+				    // Else: take it as we will not filter unfiled events..
+				    if ( !event.categories().isEmpty() )
+					    continue;
+				    else 
+					    catPassed = true;
+			    } else {
+				    if ( !event.categories().contains( cat ) )
+					    continue;
+				    else{
+					    catPassed = true;
+					    break;
+				    }
+			    }
+		    }
+	    }
+
+	    // Continue to next event if the category filter removed this item
+	    if ( !catPassed )
+		    continue;
+	    
+	    vector.insert( item++, event );
+    }
+
+    // Now sort the vector and return the list of UID's
+    vector.resize( item );
+    vector.sort();
+
+    UIDArray array( vector.count() );
+    for ( uint i= 0; i < vector.count(); i++ )
+        array[i] = vector.uidAt( i );
+
+    return array;
+    
 }
 
 OPimBackendOccurrence::List ODateBookAccessBackend::filterOccurrences( const OPimBackendOccurrence::List dayList,
                                                                        const QDateTime& dt ) {
     OPimBackendOccurrence::List tmpList;
     OPimBackendOccurrence::List::ConstIterator it;
 
     for ( it = dayList.begin(); it != dayList.end(); ++it ) {
         OPimBackendOccurrence occ = *it;
 
         /*
          * Let us find occurrences that are 'now'!
diff --git a/libopie2/opiepim/core/odatebookaccess.h b/libopie2/opiepim/core/odatebookaccess.h
index 0be8606..d2e3925 100644
--- a/libopie2/opiepim/core/odatebookaccess.h
+++ b/libopie2/opiepim/core/odatebookaccess.h
@@ -37,24 +37,49 @@
 namespace Opie {
 /**
  * This is the object orientated datebook database. It'll use OBackendFactory
  * to query for a backend.
  * All access to the datebook should be done via this class.
  * Make sure to load and save the datebook this is not part of
  * destructing and creating the object
  *
  * @author Holger Freyther, Stefan Eilers
  */
 class ODateBookAccess : public OPimAccessTemplate<OPimEvent> {
 public:
+    /**
+     * Filter for sorted()
+     * @see SortFilterBase in OPimBase
+     */
+    enum SortFilter {
+	    
+    };
+
+    /**
+     * Sort order for sorted()
+     * @see SortOrderBase in OPimBase
+     */
+    enum SortOrder {
+	    SortDescription = SortCustom,
+	    SortLocation,
+	    SortNote,
+	    SortStartTime,
+	    SortEndTime,
+	    SortStartDate,
+	    SortEndDate,
+	    SortStartDateTime,
+	    SortEndDateTime,
+	    SortAlarmDateTime,
+    };
+
     ODateBookAccess( ODateBookAccessBackend* = 0l, enum Access acc = Random );
     ~ODateBookAccess();
 
     /* return repeating events */
     List rawRepeats()const;
 
     /* return non repeating events */
     List nonRepeats()const;
 
     /* return non repeating events (from,to) */
     OPimOccurrence::List effectiveNonRepeatingEvents( const QDate& from, const QDate& to ) const;
     OPimOccurrence::List effectiveNonRepeatingEvents( const QDateTime& start ) const;
diff --git a/libopie2/opiepim/private/opimeventsortvector.cpp b/libopie2/opiepim/private/opimeventsortvector.cpp
new file mode 100644
index 0000000..4220c63
--- a/dev/null
+++ b/libopie2/opiepim/private/opimeventsortvector.cpp
@@ -0,0 +1,134 @@
+/*
+                             This file is part of the Opie Project
+                             Copyright (C) 2004 Stefan Eilers <stefan@eilers-online.net>
+              =.             Copyright (C) The Opie Team <opie-devel@handhelds.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.
+*/
+
+#include "opimeventsortvector.h"
+#include <opie2/ocontactaccess.h>
+#include <opie2/opimnotifymanager.h>
+#include <opie2/odatebookaccess.h>
+
+#include <qvaluelist.h>
+
+namespace Opie {
+namespace Internal {
+
+namespace{
+
+inline int testAlarmNotifiers( const OPimNotifyManager& leftnotifiers, const OPimNotifyManager& rightnotifiers ){
+	OPimNotifyManager::Alarms left_alarms = leftnotifiers.alarms();
+	OPimNotifyManager::Alarms right_alarms = rightnotifiers.alarms();
+	
+	// Well.. How could we compare two lists of alarms? I think we should find the most early datetimes
+	// and compare them.. (se)
+	// Find the first alarm of the left list
+	OPimNotifyManager::Alarms::Iterator it;
+	QDateTime left_earliest; // This datetime is initialized as invalid!!
+	for ( it = left_alarms.begin(); it != left_alarms.end(); ++it ){
+		if ( !left_earliest.isValid() || left_earliest > (*it).dateTime() ){
+			left_earliest = (*it).dateTime();
+		}
+	}
+	QDateTime right_earliest; // This datetime is initialized as invalid!!
+	for ( it = right_alarms.begin(); it != right_alarms.end(); ++it ){
+		if ( !right_earliest.isValid() || right_earliest > (*it).dateTime() ){
+			right_earliest = (*it).dateTime();
+		}
+	}
+	
+	int ret;
+	
+	// Now compare this found alarms
+	if ( !left_earliest .isValid() ) ret++;
+	if ( !right_earliest.isValid() ) ret--;
+	
+	if ( left_earliest.isValid() && right_earliest.isValid() ){
+		ret += left_earliest < right_earliest ? -1 : 1;    
+	}
+	
+	return ret;
+	
+}
+}
+
+OPimEventSortVector::OPimEventSortVector( uint size, bool asc, int sort )
+    : OPimSortVector<OPimEvent>( size, asc, sort ) {}
+
+int OPimEventSortVector::compareItems( const OPimEvent& left,
+                                         const OPimEvent& right ) {
+    if ( left.uid() == right.uid() )
+        return 0;
+
+    int ret = 0;
+    bool asc = sortAscending();
+
+    switch( sortOrder() ) {
+    case ODateBookAccess::SortDescription:
+        ret = testString( left.description(), right.description() );
+        break;
+    case ODateBookAccess::SortLocation:
+        ret = testString( left.location(), right.location() );
+        break;
+    case ODateBookAccess::SortNote:
+        ret = testString( left.note(),right.note() );
+        break;
+    case ODateBookAccess::SortStartTime:
+	    ret = testTime( left.startDateTime().time(), right.startDateTime().time() );
+        break;
+    case ODateBookAccess::SortEndTime:
+	    ret = testTime( left.endDateTime().time(), right.endDateTime().time() );
+        break;
+    case ODateBookAccess::SortStartDate:
+	    ret = testDate( left.startDateTime().date(), right.startDateTime().date() );
+        break;
+    case ODateBookAccess::SortEndDate:
+	    ret = testDate( left.endDateTime().date(), right.endDateTime().date() );
+        break;
+    case ODateBookAccess::SortStartDateTime:
+	    ret = testDateTime( left.startDateTime(), right.startDateTime() );
+        break;
+    case ODateBookAccess::SortEndDateTime:
+	    ret = testDateTime( left.endDateTime(), right.endDateTime() );
+        break;
+    case ODateBookAccess::SortAlarmDateTime:
+	    ret = testAlarmNotifiers( left.notifiers(), right.notifiers() );
+        break;
+    default:
+	    odebug << "OpimEventSortVector: Unknown sortOrder: " << sortOrder() << oendl;
+    }
+
+    /* twist to honor ascending/descending setting as QVector only sorts ascending */
+    if ( !asc )
+        ret *= -1;
+
+    //  Maybe differentiate as in OPimTodoSortVector ### FIXME
+    //  if( ret )
+    return ret;
+}
+
+}
+}
diff --git a/libopie2/opiepim/private/opimeventsortvector.h b/libopie2/opiepim/private/opimeventsortvector.h
new file mode 100644
index 0000000..dde26df
--- a/dev/null
+++ b/libopie2/opiepim/private/opimeventsortvector.h
@@ -0,0 +1,48 @@
+/*
+                             This file is part of the Opie Project
+                             Copyright (C) 2004 Stefan Eilers <stefan@eilers-online.net>
+              =.             Copyright (C) The Opie Team <opie-devel@handhelds.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 OPIM_CONTACT_SORT_VECTOR_H
+#define OPIM_CONTACT_SORT_VECTOR_H
+
+#include <opie2/opimevent.h>
+#include <opie2/private/opimsortvector.h>
+
+namespace Opie {
+namespace Internal {
+class OPimEventSortVector : public OPimSortVector<OPimEvent> {
+public:
+    OPimEventSortVector( uint size, bool asc, int sort );
+private:
+    int compareItems( const OPimEvent&, const OPimEvent& );
+};
+}
+}
+
+
+#endif
diff --git a/libopie2/opiepim/private/opimsortvector.h b/libopie2/opiepim/private/opimsortvector.h
index 6c21339..11a40ac 100644
--- a/libopie2/opiepim/private/opimsortvector.h
+++ b/libopie2/opiepim/private/opimsortvector.h
@@ -44,24 +44,27 @@ struct OPimSortVectorContainer {
 template<class T>
 class  OPimSortVector : public QVector<OPimSortVectorContainer<T> > {
     typedef OPimSortVectorContainer<T> VectorItem;
 public:
     OPimSortVector( uint size, bool asc, int sort );
     int compareItems( QCollection::Item d1, QCollection::Item d2 );
     bool insert( uint, const T& t );
     UID uidAt( uint i )const;
 
 protected:
     int testString( const QString&, const QString& )const;
     int testDate( const QDate&, const QDate& )const;
+    int testTime( const QTime&, const QTime& )const;
+    int testDateTime( const QDateTime& left,
+		      const QDateTime& right )const;
 protected:
     bool sortAscending()const;
     int  sortOrder()const;
 
 private:
     bool m_ascending : 1;
     int m_sort;
     virtual int compareItems( const T& item1, const T& item2 ) = 0;
 };
 
 template<class T>
 OPimSortVector<T>::OPimSortVector( uint size, bool asc, int sort )
@@ -111,28 +114,59 @@ bool OPimSortVector<T>::insert( uint i, const T& record ) {
 
 template<class T>
 UID OPimSortVector<T>::uidAt( uint index )const {
     return this->at( index )->item.uid();
 }
 
 template<class T>
 inline int OPimSortVector<T>::testString( const QString& left,
                                           const QString& right )const {
     return QString::compare( left, right );
 }
 
+
 template<class T>
 inline int OPimSortVector<T>::testDate( const QDate& left,
                                         const QDate& right )const {
     int ret = 0;
     if ( !left .isValid() ) ret++;
     if ( !right.isValid() ) ret--;
 
     if ( left.isValid() && right.isValid() )
         ret += left < right ? -1 : 1;
 
     return ret;
 }
+
+template<class T>
+inline int OPimSortVector<T>::testTime( const QTime& left,
+                                        const QTime& right )const {
+    int ret = 0;
+    if ( !left .isValid() ) ret++;
+    if ( !right.isValid() ) ret--;
+
+    if ( left.isValid() && right.isValid() ){
+	    ret += left < right ? -1 : 1;    
+    }
+
+    return ret;
+}
+
+template<class T>
+inline int OPimSortVector<T>::testDateTime( const QDateTime& left,
+                                        const QDateTime& right )const {
+    int ret = 0;
+    if ( !left .isValid() ) ret++;
+    if ( !right.isValid() ) ret--;
+
+    if ( left.isValid() && right.isValid() ){
+	    ret += left < right ? -1 : 1;    
+    }
+
+    return ret;
+
+}
+
 }
 }
 
 #endif
diff --git a/libopie2/opiepim/private/opimtodosortvector.cpp b/libopie2/opiepim/private/opimtodosortvector.cpp
index 8d15710..1db20df 100644
--- a/libopie2/opiepim/private/opimtodosortvector.cpp
+++ b/libopie2/opiepim/private/opimtodosortvector.cpp
@@ -24,24 +24,25 @@
     --        :-=`           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.
 */
 
 #include "opimtodosortvector.h"
 #include <opie2/otodoaccess.h>
 
 namespace Opie {
 namespace Internal {
 
+namespace{
 inline QString string( const OPimTodo& todo) {
     return  todo.summary().isEmpty() ?
         todo.description().left(20 ) :
         todo.summary();
 }
 
 inline int completed( const OPimTodo& todo1, const OPimTodo& todo2) {
     int ret = 0;
     if ( todo1.isCompleted() ) ret++;
     if ( todo2.isCompleted() ) ret--;
     return ret;
 }
@@ -60,24 +61,25 @@ inline int deadline( const OPimTodo& t1, const OPimTodo& t2) {
          t2.hasDueDate() )
         ret = t2.dueDate().daysTo( t1.dueDate() );
     else if ( t1.hasDueDate() )
         ret = -1;
     else if ( t2.hasDueDate() )
         ret = 1;
     else
         ret = 0;
 
     return ret;
 }
 
+}
 
 OPimTodoSortVector::OPimTodoSortVector( uint size, bool asc, int sort )
     : OPimSortVector<OPimTodo>( size, asc, sort )
 {}
 
 int OPimTodoSortVector::compareItems( const OPimTodo& con1, const OPimTodo& con2 ) {
     bool seComp, sePrio, seSum, seDeadline;
     seComp = sePrio = seDeadline = seSum = false;
     int ret =0;
     bool asc = sortAscending();
 
     /* same item */
diff --git a/libopie2/opiepim/private/private.pro b/libopie2/opiepim/private/private.pro
index 618c2d6..92c24cb 100644
--- a/libopie2/opiepim/private/private.pro
+++ b/libopie2/opiepim/private/private.pro
@@ -1,9 +1,11 @@
 HEADERS += private/vobject_p.h                \
 	   private/opimcontactsortvector.h    \
+	   private/opimeventsortvector.h      \
 	   private/opimoccurrence_p.h         \
 	   private/opimsortvector.h           \
 	   private/opimtodosortvector.h 
 
 SOURCES += private/opimcontactsortvector.cpp  \
+	   private/opimeventsortvector.cpp    \
 	   private/opimtodosortvector.cpp