Fix API docu

1 files changed, 6 insertions, 6 deletions

diff --git a/library/datebookdb.cpp b/library/datebookdb.cpp
index 0fedfa8..2f33255 100644
--- a/library/datebookdb.cpp
+++ b/library/datebookdb.cpp
@@ -26,97 +26,97 @@
 #include <qtextstream.h>
 #include <qtl.h>
 
 #include <qpe/alarmserver.h>
 #include <qpe/global.h>
 #include "datebookdb.h"
 #include <qpe/stringutil.h>
 #include <qpe/timeconversion.h>
 
 #include <errno.h>
 #include <stdlib.h>
 
 
 class DateBookDBPrivate
 {
 public:
     bool clean;  // indcate whether we need to write to disk...
 };
 
 
 // Helper functions
 
 static QString dateBookJournalFile()
 {
     QString str = getenv("HOME");
     return QString( str +"/.caljournal" );
 }
 
 static QString dateBookFilename()
 {
     return Global::applicationFileName("datebook","datebook.xml");
 }
 
 /* Calculating the next event of a recuring event is actually
    computationally inexpensive, esp. compared to checking each day
    individually.  There are bad worse cases for say the 29th of
    february or the 31st of some other months.  However
    these are still bounded */
 bool nextOccurance(const Event &e, const QDate &from, QDateTime &next)
 {
     // easy checks, first are we too far in the future or too far in the past?
     QDate tmpDate;
     int freq = e.repeatPattern().frequency;
     int diff, diff2, a;
     int iday, imonth, iyear;
     int dayOfWeek = 0;
     int firstOfWeek = 0;
     int weekOfMonth;
-    
+
 
     if (e.repeatPattern().hasEndDate && e.repeatPattern().endDate() < from)
 	return FALSE;
 
     if (e.start() >= from) {
 	next = e.start();
 	return TRUE;
     }
 
     switch ( e.repeatPattern().type ) {
 	case Event::Weekly:
 	    /* weekly is just daily by 7 */
 	    /* first convert the repeatPattern.Days() mask to the next
 	       day of week valid after from */
             dayOfWeek = from.dayOfWeek();
 	    dayOfWeek--; /* we want 0-6, doco for above specs 1-7 */
 
 	    /* this is done in case freq > 1 and from in week not
 	       for this round */
 	    // firstOfWeek = 0; this is already done at decl.
 	    while(!((1 << firstOfWeek) & e.repeatPattern().days))
 		firstOfWeek++;
 
 	    /* there is at least one 'day', or there would be no event */
 	    while(!((1 << (dayOfWeek % 7)) & e.repeatPattern().days))
 		dayOfWeek++;
 
 	    dayOfWeek = dayOfWeek % 7; /* the actual day of week */
 	    dayOfWeek -= e.start().date().dayOfWeek() -1;
 
 	    firstOfWeek = firstOfWeek % 7; /* the actual first of week */
 	    firstOfWeek -= e.start().date().dayOfWeek() -1;
 
 	    // dayOfWeek may be negitive now
 	    // day of week is number of days to add to start day
 
 	    freq *= 7;
 	    // FALL-THROUGH !!!!!
 	case Event::Daily:
 	    // the add is for the possible fall through from weekly */
 	    if(e.start().date().addDays(dayOfWeek) > from) {
 		/* first week exception */
 		next = QDateTime(e.start().date().addDays(dayOfWeek),
 				 e.start().time());
 		if ((next.date() > e.repeatPattern().endDate())
 		    && e.repeatPattern().hasEndDate)
 		    return FALSE;
 		return TRUE;
@@ -416,142 +416,142 @@ QValueList<Event> DateBookDB::getEvents( const QDate &from, const QDate &to )
 	    r.setEndDate( to );
 	    r.hasEndDate = TRUE;
 	}
 	dummy_event.setRepeat(TRUE, r);
 
 	while (nextOccurance(dummy_event, itDate, due)) {
 	    if (due.date() > to)
 		break;
 	    Event newEvent = *it;
 	    newEvent.setStart(due);
 	    newEvent.setEnd(due.addSecs((*it).start().secsTo((*it).end())));
 
 	    tmpList.append(newEvent);
 	    itDate = due.date().addDays(1);  /* the next event */
 	}
     }
     qHeapSort(tmpList);
     return tmpList;
 }
 
 QValueList<Event> DateBookDB::getEvents( const QDateTime &start )
 {
     QValueList<Event> day = getEvents(start.date(),start.date());
 
     QValueListConstIterator<Event> it;
     QDateTime dtTmp;
     QValueList<Event> tmpList;
     for (it = day.begin(); it != day.end(); ++it ) {
         dtTmp = (*it).start(TRUE);
         if ( dtTmp == start )
             tmpList.append( *it );
     }
     return tmpList;
 }
 
 //#### Why is this code duplicated in getEvents ?????
 
 QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
 							   const QDate &to )
 {
     QValueList<EffectiveEvent> tmpList;
     QValueListIterator<Event> it;
 
     EffectiveEvent effEv;
     QDateTime dtTmp,
 	      dtEnd;
 
     for (it = eventList.begin(); it != eventList.end(); ++it ) {
-	if (!(*it).isValidUid()) 
+	if (!(*it).isValidUid())
 	    (*it).assignUid(); // FIXME: Hack to restore cleared uids
 
         dtTmp = (*it).start(TRUE);
 	dtEnd = (*it).end(TRUE);
 
         if ( dtTmp.date() >= from && dtTmp.date() <= to ) {
 	    Event tmpEv = *it;
 	    effEv.setEvent(tmpEv);
 	    effEv.setDate( dtTmp.date() );
 	    effEv.setStart( dtTmp.time() );
 	    if ( dtTmp.date() != dtEnd.date() )
 		effEv.setEnd( QTime(23, 59, 0) );
 	    else
 		effEv.setEnd( dtEnd.time() );
             tmpList.append( effEv );
 	}
 	// we must also check for end date information...
 	if ( dtEnd.date() != dtTmp.date() && dtEnd.date() >= from ) {
 	    QDateTime dt = dtTmp.addDays( 1 );
 	    dt.setTime( QTime(0, 0, 0) );
 	    QDateTime dtStop;
 	    if ( dtEnd > to ) {
 		dtStop = to;
 	    } else
 		dtStop = dtEnd;
 	    while ( dt <= dtStop ) {
 		Event tmpEv = *it;
 		effEv.setEvent( tmpEv );
 		effEv.setDate( dt.date() );
 		if ( dt >= from ) {
 		    effEv.setStart( QTime(0, 0, 0) );
 		    if ( dt.date() == dtEnd.date() )
 			effEv.setEnd( dtEnd.time() );
 		    else
 			effEv.setEnd( QTime(23, 59, 59) );
 		    tmpList.append( effEv );
 		}
 		dt = dt.addDays( 1 );
 	    }
 	}
     }
     // check for repeating events...
     QDateTime repeat;
     for ( it = repeatEvents.begin(); it != repeatEvents.end(); ++it ) {
-	if (!(*it).isValidUid()) 
+	if (!(*it).isValidUid())
 	    (*it).assignUid(); // FIXME: Hack to restore cleared uids
 
 	/* create a false end date, to short circuit on hard
 	   MonthlyDay recurences */
 	Event dummy_event = *it;
 	int duration = (*it).start().date().daysTo( (*it).end().date() );
 	QDate itDate = from.addDays(-duration);
 
 	Event::RepeatPattern r = dummy_event.repeatPattern();
 	if ( !r.hasEndDate || r.endDate() > to ) {
 	    r.setEndDate( to );
 	    r.hasEndDate = TRUE;
 	}
 	dummy_event.setRepeat(TRUE, r);
 
 	while (nextOccurance(dummy_event, itDate, repeat)) {
 	    if(repeat.date() > to)
 		break;
 	    effEv.setDate( repeat.date() );
 	    if ((*it).type() == Event::AllDay) {
 		effEv.setStart( QTime(0,0,0) );
 		effEv.setEnd( QTime(23,59,59) );
 	    } else {
 		/* we only occur by days, not hours/minutes/seconds.  Hence
 		   the actual end and start times will be the same for
 		   every repeated event.  For multi day events this is
 		   fixed up later if on wronge day span */
 		effEv.setStart( (*it).start().time() );
 		effEv.setEnd( (*it).end().time() );
 	    }
 	    if ( duration != 0 ) {
 		// multi-day repeating events
 		QDate sub_it = QMAX( repeat.date(), from );
 		QDate startDate = repeat.date();
 		QDate endDate = startDate.addDays( duration );
 
 		while ( sub_it <= endDate && sub_it  <= to ) {
 		    EffectiveEvent tmpEffEv = effEv;
 		    Event tmpEv = *it;
 		    tmpEffEv.setEvent( tmpEv );
 
 		    if ( sub_it != startDate )
 			tmpEffEv.setStart( QTime(0,0,0) );
 		    if ( sub_it != endDate )
 			tmpEffEv.setEnd( QTime(23,59,59) );
 		    tmpEffEv.setDate( sub_it );
 		    tmpEffEv.setEffectiveDates( startDate, endDate );
 		    tmpList.append( tmpEffEv );
@@ -578,197 +578,197 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDateTime &dt)
     QValueList<EffectiveEvent> tmpList;
     QDateTime dtTmp;
 
     for (it = day.begin(); it != day.end(); ++it ) {
         dtTmp = QDateTime( (*it).date(), (*it).start() );
 	// at the moment we don't have second granularity, be nice about that..
         if ( QABS(dt.secsTo(dtTmp)) < 60 )
             tmpList.append( *it );
     }
     return tmpList;
 }
 
 void DateBookDB::addEvent( const Event &ev, bool doalarm )
 {
     // write to the journal...
     saveJournalEntry( ev, ACTION_ADD, -1, false );
     addJFEvent( ev, doalarm );
     d->clean = false;
 }
 
 void DateBookDB::addJFEvent( const Event &ev, bool doalarm )
 {
     if ( doalarm && ev.hasAlarm() )
 	addEventAlarm( ev );
     if ( ev.hasRepeat() )
 	repeatEvents.append( ev );
     else
 	eventList.append( ev );
 }
 
 void DateBookDB::editEvent( const Event &old, Event &editedEv )
 {
     int oldIndex=0;
     bool oldHadRepeat = old.hasRepeat();
     Event orig;
 
     // write to the journal...
     if ( oldHadRepeat ) {
 	if ( origRepeat( old, orig ) ) // should work always...
 	    oldIndex = repeatEvents.findIndex( orig );
     } else
 	oldIndex = eventList.findIndex( old );
     saveJournalEntry( editedEv, ACTION_REPLACE, oldIndex, oldHadRepeat );
 
     // Delete old event
     if ( old.hasAlarm() )
 	delEventAlarm( old );
     if ( oldHadRepeat ) {
-	if ( editedEv.hasRepeat() ) { // This mean that origRepeat was run above and 
+	if ( editedEv.hasRepeat() ) { // This mean that origRepeat was run above and
  	                              // orig is initialized
 	    // assumption, when someone edits a repeating event, they
 	    // want to change them all, maybe not perfect, but it works
 	    // for the moment...
 	    repeatEvents.remove( orig );
 	} else
 	    removeRepeat( old );
     } else {
 	QValueList<Event>::Iterator it = eventList.find( old );
 	if ( it != eventList.end() )
 	    eventList.remove( it );
     }
 
     // Add new event
     if ( editedEv.hasAlarm() )
 	addEventAlarm( editedEv );
     if ( editedEv.hasRepeat() )
 	repeatEvents.append( editedEv );
     else
 	eventList.append( editedEv );
 
     d->clean = false;
 }
 
 void DateBookDB::removeEvent( const Event &ev )
 {
     // write to the journal...
     saveJournalEntry( ev, ACTION_REMOVE, -1, false );
     removeJFEvent( ev );
     d->clean = false;
 }
 
 void DateBookDB::removeJFEvent( const Event&ev )
 {
     if ( ev.hasAlarm() )
 	delEventAlarm( ev );
     if ( ev.hasRepeat() ) {
 	removeRepeat( ev );
     } else {
 	QValueList<Event>::Iterator it = eventList.find( ev );
 	if ( it != eventList.end() )
 	    eventList.remove( it );
     }
 }
 
 // also handles journaling...
 void DateBookDB::loadFile( const QString &strFile )
 {
-    
+
     QFile f( strFile );
     if ( !f.open( IO_ReadOnly ) )
 	return;
 
     enum Attribute {
 	FDescription = 0,
 	FLocation,
 	FCategories,
 	FUid,
 	FType,
 	FAlarm,
 	FSound,
 	FRType,
 	FRWeekdays,
 	FRPosition,
 	FRFreq,
 	FRHasEndDate,
 	FREndDate,
 	FRStart,
 	FREnd,
 	FNote,
 	FCreated,
 	FAction,
 	FActionKey,
 	FJournalOrigHadRepeat
     };
 
     QAsciiDict<int> dict( 97 );
     dict.setAutoDelete( TRUE );
     dict.insert( "description", new int(FDescription) );
     dict.insert( "location", new int(FLocation) );
     dict.insert( "categories", new int(FCategories) );
     dict.insert( "uid", new int(FUid) );
     dict.insert( "type", new int(FType) );
     dict.insert( "alarm", new int(FAlarm) );
     dict.insert( "sound", new int(FSound) );
     dict.insert( "rtype", new int(FRType) );
     dict.insert( "rweekdays", new int(FRWeekdays) );
     dict.insert( "rposition", new int(FRPosition) );
     dict.insert( "rfreq", new int(FRFreq) );
     dict.insert( "rhasenddate", new int(FRHasEndDate) );
     dict.insert( "enddt", new int(FREndDate) );
     dict.insert( "start", new int(FRStart) );
     dict.insert( "end", new int(FREnd) );
     dict.insert( "note", new int(FNote) );
     dict.insert( "created", new int(FCreated) );
     dict.insert( "action", new int(FAction) );
     dict.insert( "actionkey", new int(FActionKey) );
     dict.insert( "actionorig", new int (FJournalOrigHadRepeat) );
 
-    
+
     QByteArray ba = f.readAll();
     char* dt = ba.data();
     int len = ba.size();
     int currentAction,
 	journalKey,
 	origHadRepeat;  // should be bool, but we need tri-state(not being used)
 
     int i = 0;
     char *point;
     // hack to get rid of segfaults after reading </DATEBOOK>
     while ( (dt+i != 0) && (( point = strstr( dt+i, "<event " ) ) != 0 )) {
 	i = point - dt;
 	// if we are reading in events in the general case,
 	// we are just adding them, so let the actions represent that...
 	currentAction = ACTION_ADD;
 	journalKey = -1;
 	origHadRepeat = -1;
 	// some temporary variables for dates and times ...
 	//int startY = 0, startM = 0, startD = 0, starth = 0, startm = 0, starts = 0;
 	//int endY = 0, endM = 0, endD = 0, endh = 0, endm = 0, ends = 0;
 	//int enddtY = 0, enddtM = 0, enddtD = 0;
 
 	// ... for the alarm settings ...
 	int alarmTime = -1; Event::SoundTypeChoice alarmSound = Event::Silent;
 	// ... and for the recurrence
 	Event::RepeatPattern rp;
 	Event e;
 
 	i += 7;
 
 	while( 1 ) {
 	    while ( i < len && (dt[i] == ' ' || dt[i] == '\n' || dt[i] == '\r') )
 		++i;
 	    if ( i >= len-2 || (dt[i] == '/' && dt[i+1] == '>') )
 		break;
 	    // we have another attribute, read it.
 	    int j = i;
 	    while ( j < len && dt[j] != '=' )
 		++j;
 	    char *attr = dt+i;
 	    dt[j] = '\0';
 	    i = ++j; // skip =
 	    while ( i < len && dt[i] != '"' )
 		++i;
 	    j = ++i;
 	    bool haveAmp = FALSE;
 	    bool haveUtf = FALSE;
 	    while ( j < len && dt[j] != '"' ) {