Implement default sort functions for contact last name and birthday/anniversary. The latter is required for sorting birthdays/anniversaries correctly on the today screen.

Fixes bug #1760.

2 files changed, 38 insertions, 0 deletions

diff --git a/libopie2/opiepim/private/opimcontactsortvector.cpp b/libopie2/opiepim/private/opimcontactsortvector.cpp
index 8c7d5ca..c8de4d1 100644
--- a/libopie2/opiepim/private/opimcontactsortvector.cpp
+++ b/libopie2/opiepim/private/opimcontactsortvector.cpp
@@ -1,108 +1,122 @@
 /*
                              This file is part of the Opie Project
                              Copyright (C) 2004 Holger Freyther <freyther@handhelds.org>
               =.             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 "opimcontactsortvector.h"
 #include <opie2/ocontactaccess.h>
 
 namespace Opie {
 namespace Internal {
 OPimContactSortVector::OPimContactSortVector( uint size, bool asc, int sort )
     : OPimSortVector<OPimContact>( size, asc, sort ) {}
 
 int OPimContactSortVector::compareItems( const OPimContact& left,
                                          const OPimContact& right ) {
     if ( left.uid() == right.uid() )
         return 0;
 
     bool soTitle, soSummary, soFirstName, soMiddleName, soSuffix, soEmail,
         soNick, soFileAs, soAnni, soBirth, soGender;
     soTitle = soSummary = soFirstName = soMiddleName = soSuffix = soEmail =
      soNick = soFileAs = soAnni = soBirth = soGender = false;
     int ret = 0;
     bool asc = sortAscending();
 
     switch( sortOrder() ) {
     case OPimContactAccess::SortSummary:
         ret = testString( left.fileAs(), right.fileAs() );
         soSummary = true;
         break;
     case OPimContactAccess::SortTitle:
         ret = testString( left.title(), right.title() );
         soTitle = true;
         break;
     case OPimContactAccess::SortFirstName:
         ret = testString( left.firstName(), right.firstName() );
         soFirstName = true;
         break;
     case OPimContactAccess::SortMiddleName:
         ret = testString( left.middleName(), right.middleName() );
         soMiddleName = true;
         break;
+    case OPimContactAccess::SortLastName:
+        ret = testString( left.lastName(), right.lastName() );
+        break;
     case OPimContactAccess::SortSuffix:
         ret = testString( left.suffix(), right.suffix() );
         soSuffix = true;
         break;
     case OPimContactAccess::SortEmail:
         ret = testString( left.defaultEmail(), right.defaultEmail() );
         soEmail = true;
         break;
     case OPimContactAccess::SortNickname:
         ret = testString( left.nickname(), right.nickname() );
         soNick = true;
         break;
     case OPimContactAccess::SortFileAsName:
         ret = testString( left.fileAs(), right.fileAs() );
         soFileAs = true;
         break;
     case OPimContactAccess::SortAnniversary:
         ret = testDate( left.anniversary(), right.anniversary() );
         soAnni = true;
         break;
     case OPimContactAccess::SortByDate:
     case OPimContactAccess::SortBirthday:
         ret = testDate( left.birthday(), right.birthday() );
         soBirth = true;
         break;
     case OPimContactAccess::SortGender:
         ret = testString( left.gender(), right.gender() );
         soGender = true;
         break;
+    case OPimContactAccess::SortBirthdayWithoutYear:
+        // This doesn't actually just sort by the date without year,
+        // it actually works out the days until the next occurrence,
+        // which is more useful since it will work correctly when
+        // crossing year boundaries. - Paul Eggleton Dec 2006
+        ret = testDaysUntilNextDate( left.birthday(), right.birthday() );
+        break;
+    case OPimContactAccess::SortAnniversaryWithoutYear:
+        // (as above)
+        ret = testDaysUntilNextDate( left.anniversary(), right.anniversary() );
+        break;
     }
 
     /* 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/opimsortvector.h b/libopie2/opiepim/private/opimsortvector.h
index 11a40ac..9684ca1 100644
--- a/libopie2/opiepim/private/opimsortvector.h
+++ b/libopie2/opiepim/private/opimsortvector.h
@@ -1,172 +1,196 @@
 /*
                              This file is part of the Opie Project
                              Copyright (C) 2004 Holger Freyther <freyther@handhelds.org>
               =.             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 OPIE_PIM_SORT_VECTOR_H
 #define OPIE_PIM_SORT_VECTOR_H
 
 #include <opie2/opimglobal.h>
 
 #include <qvector.h>
 
 namespace Opie {
 namespace Internal {
 template<class T>
 struct OPimSortVectorContainer {
     T item;
 };
 
 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;
+    int testDaysUntilNextDate( const QDate& left,
+          const QDate& 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 )
     : QVector<VectorItem>( size ), m_ascending( asc ),
       m_sort( sort ) {
     this->setAutoDelete( true );
 }
 
 /**
  * Returns:
  *       0 if item1 == item2
  *
  *   non-zero if item1 != item2
  *
  *   This function returns int rather than bool so that reimplementations
  *   can return one of three values and use it to sort by:
  *
  *   0 if item1 == item2
  *
  *   > 0 (positive integer) if item1 > item2
  *
  *   < 0 (negative integer) if item1 < item2
  *
  */
 template<class T>
 int OPimSortVector<T>::compareItems( QCollection::Item d1, QCollection::Item d2 ) {
     return compareItems( ((VectorItem*)d1)->item,
                          ((VectorItem*)d2)->item );
 }
 
 template<class T>
 bool OPimSortVector<T>::sortAscending()const {
     return m_ascending;
 }
 
 template<class T>
 int OPimSortVector<T>::sortOrder()const {
     return m_sort;
 }
 
 template<class T>
 bool OPimSortVector<T>::insert( uint i, const T& record ) {
     VectorItem *item = new VectorItem;
     item->item = record;
     return QVector<VectorItem>::insert( i, item );
 }
 
 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;
 
 }
 
+template<class T>
+inline int OPimSortVector<T>::testDaysUntilNextDate( const QDate& left,
+                                        const QDate& right )const {
+    int ret = 0;
+    if ( !left .isValid() ) ret++;
+    if ( !right.isValid() ) ret--;
+
+    if ( left.isValid() && right.isValid() ){
+        int currentYear = QDate::currentDate().year();
+        QDate nextLeft( currentYear, left.month(), left.day() );
+        if ( QDate::currentDate().daysTo(nextLeft) < 0 )
+            nextLeft.setYMD( currentYear+1, left.month(), left.day() );
+        QDate nextRight( currentYear, right.month(), right.day() );
+        if ( QDate::currentDate().daysTo(nextRight) < 0 )
+            nextRight.setYMD( currentYear+1, right.month(), right.day() );
+
+        ret += QDate::currentDate().daysTo(nextLeft) < QDate::currentDate().daysTo(nextRight) ? -1 : 1;
+    }
+
+    return ret;
+}
+
 }
 }
 
 #endif