Add Documentation on how we search and why we do stuff

1 files changed, 12 insertions, 0 deletions

diff --git a/core/pim/datebook/datebook.cpp b/core/pim/datebook/datebook.cpp
index 832b2f8..24affd0 100644
--- a/core/pim/datebook/datebook.cpp
+++ b/core/pim/datebook/datebook.cpp
@@ -808,268 +808,280 @@ void DateBook::closeEvent( QCloseEvent *e )
         if ( db->save() ) {
                 e->accept();
         } else {
                 if ( QMessageBox::critical( this, tr( "Out of space" ),
                                                 tr("Calendar was unable to save\n"
                                                 "your changes.\n"
                                                 "Free up some space and try again.\n"
                                                 "\nQuit anyway?"),
                                                 QMessageBox::Yes|QMessageBox::Escape,
                                                 QMessageBox::No|QMessageBox::Default )
                         != QMessageBox::No )
                         e->accept();
                 else
                         e->ignore();
     }
 }
 
 // Entering directly from the "keyboard"
 void DateBook::slotNewEventFromKey( const QString &str )
 {
     if (syncing) {
         QMessageBox::warning( this, tr("Calendar"),
                               tr( "Can not edit data, currently syncing") );
         return;
     }
 
     // We get to here from a key pressed in the Day View
     // So we can assume some things.  We want the string
     // passed in to be part of the description.
     QDateTime start, end;
     if ( views->visibleWidget() == dayView ) {
         dayView->selectedDates( start, end );
     } else if ( views->visibleWidget() == monthView ) {
         QDate d = monthView->selectedDate();
         start = end = d;
         start.setTime( QTime( 10, 0 ) );
         end.setTime( QTime( 12, 0 ) );
     } else if ( views->visibleWidget() == weekView ) {
         QDate d = weekView->date();
         start = end = d;
         start.setTime( QTime( 10, 0 ) );
         end.setTime( QTime( 12, 0 ) );
     } else if ( views->visibleWidget() == weekLstView ) {
         QDate d = weekLstView->date();
         start = end = d;
         start.setTime( QTime( 10, 0 ) );
         end.setTime( QTime( 12, 0 ) );
         }
     slotNewEntry(start, end, str);
 }
 void DateBook::slotNewEntry(const QDateTime &start, const QDateTime &end, const QString &str, const QString &location) {
         // argh!  This really needs to be encapsulated in a class
         // or function.
         QDialog newDlg( this, 0, TRUE );
         newDlg.setCaption( DateEntryBase::tr("New Event") );
         DateEntry *e;
         QVBoxLayout *vb = new QVBoxLayout( &newDlg );
         QScrollView *sv = new QScrollView( &newDlg );
         sv->setResizePolicy( QScrollView::AutoOneFit );
         sv->setFrameStyle( QFrame::NoFrame );
         sv->setHScrollBarMode( QScrollView::AlwaysOff );
         vb->addWidget( sv );
 
         Event ev;
         ev.setDescription(  str );
         // When the new gui comes in, change this...
         if(location==0) {
                 if(defaultLocation.isEmpty()) {
                         ev.setLocation(tr("(Unknown)"));
                 } else {
                         ev.setLocation( defaultLocation );
                 }
         } else {
                 ev.setLocation(location);
         }
         ev.setCategories(defaultCategories);
         ev.setStart( start );
         ev.setEnd( end );
 
         e = new DateEntry( onMonday, ev, ampm, &newDlg );
         e->setAlarmEnabled( aPreset, presetTime, Event::Loud );
         sv->addChild( e );
         while ( QPEApplication::execDialog( &newDlg ) ) {
                 ev = e->event();
                 ev.assignUid();
                 QString error = checkEvent( ev );
                 if ( !error.isNull() ) {
                 if ( QMessageBox::warning( this, tr("Error!"), error, tr("Fix it"), tr("Continue"), 0, 0, 1 ) == 0 )
                         continue;
                 }
                 db->addEvent( ev );
                 emit newEvent();
                 break;
         }
 }
 
 void DateBook::setDocument( const QString &filename )
 {
     if ( filename.find(".vcs") != int(filename.length()) - 4 ) return;
 
     QValueList<Event> tl = Event::readVCalendar( filename );
     for( QValueList<Event>::Iterator it = tl.begin(); it != tl.end(); ++it ) {
         db->addEvent( *it );
     }
 }
 
 static const char * beamfile = "/tmp/obex/event.vcs";
 
 void DateBook::beamEvent( const Event &e )
 {
     qDebug("trying to beamn");
     unlink( beamfile ); // delete if exists
     mkdir("/tmp/obex/", 0755);
     Event::writeVCalendar( beamfile, e );
     Ir *ir = new Ir( this );
     connect( ir, SIGNAL( done( Ir * ) ), this, SLOT( beamDone( Ir * ) ) );
     QString description = e.description();
     ir->send( beamfile, description, "text/x-vCalendar" );
 }
 
 void DateBook::beamDone( Ir *ir )
 {
     delete ir;
     unlink( beamfile );
 }
 
 void DateBook::slotFind()
 {
     // move it to the day view...
     viewDay();
     FindDialog frmFind( "Calendar", this ); // no tr needed
     frmFind.setUseDate( true );
     frmFind.setDate( currentDate() );
     QObject::connect( &frmFind,
                       SIGNAL(signalFindClicked(const QString&, const QDate&,
                                                bool, bool, int)),
                       this,
                       SLOT(slotDoFind(const QString&, const QDate&,
                                       bool, bool, int)) );
     QObject::connect( this,
                       SIGNAL(signalNotFound()),
                       &frmFind,
                       SLOT(slotNotFound()) );
     QObject::connect( this,
                       SIGNAL(signalWrapAround()),
                       &frmFind,
                       SLOT(slotWrapAround()) );
         frmFind.move(0,0);
     frmFind.exec();
     inSearch = false;
 }
 
 bool catComp( QArray<int> cats, int category )
 {
     bool returnMe;
     int i,
         count;
 
     count = int(cats.count());
     returnMe = false;
     if ( (category == -1 && count == 0) || category == -2 )
         returnMe = true;
     else {
         for ( i = 0; i < count; i++ ) {
             if ( category == cats[i] ) {
                 returnMe = true;
                 break;
             }
         }
     }
     return returnMe;
 }
 
 
 void DateBook::slotDoFind( const QString& txt, const QDate &dt,
                            bool caseSensitive, bool /*backwards*/,
                            int category )
 {
     QDateTime dtEnd( QDate(3001, 1, 1), QTime(0, 0, 0) ),
         next;
 
     QRegExp r( txt );
     r.setCaseSensitive( caseSensitive );
 
 
     static Event rev, nonrev;
     if ( !inSearch ) {
         rev.setStart( QDateTime(QDate(1960, 1, 1), QTime(0, 0, 0)) );
         nonrev.setStart( rev.start() );
         inSearch = true;
     }
     static QDate searchDate = dt;
+    // if true at the end we will start at the begin again and afterwards
+    // we will emit string not found
     static bool wrapAround = true;
     bool candidtate;
     candidtate = false;
 
     QValueList<Event> repeats = db->getRawRepeats();
 
     // find the candidate for the first repeat that matches...
+    // first check if there can ever be a match and then compute
+    // the next occurence from start. See if this event is  closer
+    // to the beginning (start. next < dtEnd) and not smaller then the last
+    // result. If we find a canditate we set the dtEnd to the time
+    // of the ocurrence and rev to this occurence.
+    // set wrap around to true because there might be more events coming
+    // and we're not at the end.
     QValueListConstIterator<Event> it;
     QDate start = dt;
     for ( it = repeats.begin(); it != repeats.end(); ++it ) {
         if ( catComp( (*it).categories(), category ) ) {
             if ( (*it).match( r ) ) {
                 if ( nextOccurance( *it, start, next ) ) {
                     if ( next < dtEnd && !(next <= rev.start() ) ) {
                         rev = *it;
                         dtEnd = next;
                         rev.setStart( next );
                         candidtate = true;
                         wrapAround = true;
                     }
                 }
             }
         }
     }
 
     // now the for first non repeat...
+    // dtEnd is set by the previous iteration of repeatingEvents
+    // check if we find a closer item. Also set dtEnd to find even
+    // more close occurrence
     QValueList<Event> nonRepeats = db->getNonRepeatingEvents( dt, dtEnd.date() );
     qHeapSort( nonRepeats.begin(), nonRepeats.end() );
     for ( it = nonRepeats.begin(); it != nonRepeats.end(); ++it ) {
         if ( catComp( (*it).categories(), category ) ) {
             if ( (*it).start() < dtEnd ) {
                 if ( (*it).match( r ) && !(*it <= nonrev) ) {
                     nonrev = *it;
                     dtEnd = nonrev.start();
                     candidtate = true;
                     wrapAround = true;
                     break;
                 }
             }
         }
     }
     if ( candidtate ) {
         dayView->setStartViewTime( dtEnd.time().hour() );
         dayView->setDate( dtEnd.date().year(), dtEnd.date().month(),
                           dtEnd.date().day() );
     } else {
         if ( wrapAround ) {
             emit signalWrapAround();
             rev.setStart( QDateTime(QDate(1960, 1, 1), QTime(0, 0, 0)) );
             nonrev.setStart( rev.start() );
         } else
             emit signalNotFound();
         wrapAround = !wrapAround;
     }
 }
 
 Event DateBookDBHack::eventByUID(int uid) {
 
     // FIXME: Dirty Hacks to get hold of the private event lists
     QDate start;
     QDate end=start.addDays(-1);
     QValueList<Event> myEventList=getNonRepeatingEvents(start,end);
     QValueList<Event> myRepeatEvents=getRawRepeats();
 
     QValueList<Event>::ConstIterator it;
 
     for (it = myEventList.begin(); it != myEventList.end(); it++) {
         if ((*it).uid() == uid) return *it;
     }
     for (it = myRepeatEvents.begin(); it != myRepeatEvents.end(); it++) {
         if ((*it).uid() == uid) return *it;
     }
 
     Event ev;
     return ev; // return at least
 }