kpilot/lib/recordConduit.h

#ifndef _KPILOT_RECORDCONDUIT_H
#define _KPILOT_RECORDCONDUIT_H
/* record-conduit.h                           KPilot
**
** Copyright (C) 2005 by Adriaan de Groot
**
*/

/*
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** 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 General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program in a file called COPYING; if not, write to
** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA 02110-1301, USA.
*/

/*
** Bug reports and questions can be sent to kde-pim@kde.org
*/

#include <tqtimer.h>
#include <tdelocale.h>

#include "plugin.h"
#include "pilot.h"
#include "pilotDatabase.h"
#include "kpilotdevicelink.h"

class KPilotDeviceLink;

/** @file
*
* This file defines a generic syncing framework for Palm Pilot oriented data.
* It is a lot like KitchenSync's Syncees and such. Basically, we define a
* generic container for data on the PC side and give that container an API
* for searching for a specific handheld record. Syncing consists of iterating
* through the handheld's records and looking up the PC data for each record,
* and then syncing.
*
*/

/** An intermediate class that introduces the slots we need for our sync
* implementation. This is here _only_ because mixing moc with template
* classes sounds really scary.
*/

class RecordConduitBase : public ConduitAction
{
Q_OBJECT
  
public:
	/** Constructor. The TQStringList @p a sets flags for the ConduitAction.
	*/
	RecordConduitBase(KPilotDeviceLink *o,
		const char *n,
		const TQStringList a = TQStringList()) :
		ConduitAction(o,n,a),
		fTimer(0L)
	{
	} ;
	/** Destructor. */
	virtual ~RecordConduitBase()
	{
		// delete fTimer; // Timer is a child object
	} ;

	/** Return values for the processing functions. Each should return
	* NotDone if it needs to be called again (e.g. to process another record),
	* Done if it is finished and something else should be done, and
	* Error if the sync cannot be completed.
	*/
	enum SyncProgress { NotDone=0, Done=1, Error=2 } ;

	/** Returns a human-readable name for the progress indicator @p s */
	static TQString name(SyncProgress s);

	/** State of the conduit's sync. This is changed by process(). */
	enum States { Initialize, PalmToPC, PCToPalm, Cleanup } ;

	static TQString name(States s);

protected:
	/** Function called at the beginning of a sync to load data from the PC.
	* @return Done when the load has finished.
	* @see process
	*/
	virtual SyncProgress loadPC() = 0;

	/** Function called repeatedly to fetch the next modified entry from the Palm and
	* sync it with the PC by looking up the record, and calling the syncer for it.
	*
	* @return Dome when there are no more modified records on the Palm
	* @see process()
	*/
	virtual SyncProgress palmRecToPC() = 0;

	/** Function called repeatedly to fetch the next modified entry from the PC and
	* sync it with the Palm by looking up the record and calling the syncer for it.
	*
	* @return Done when there are no more modified records on the PC
	* @see process()
	*/
	virtual SyncProgress pcRecToPalm() = 0;

	/** Function called at the end of this conduit's sync, which should reset DB flags
	* and write changed config data out to disk.
	*
	* @return Done when the cleanup is complete.
	* @see process()
	*/
	virtual SyncProgress cleanup() = 0;

protected slots:
	/** Slot used for the implementation of a state machine: calls each of the
	* relevant other slots (above) as needed until they return true.
	*/
	void process();

protected:
	virtual bool exec();

private:
	/** Timer to signal the process() slot. Used to keep the UI responsive. */
	TQTimer *fTimer;

	States fState;

	Pilot::RecordIDList fIDList;
	Pilot::RecordIDList::Iterator fIDListIterator;

	TQString fDBName;
} ;

template <class PCEntry, class PCContainer, class HHEntry, class HHAppInfo, class Syncer>
class RecordConduit : public RecordConduitBase
{
public:
	/** Construct a record conduit on a given device link. */
	RecordConduit(
		KPilotDeviceLink *o /**< Connection to HH */,
		const char *n /**< Name for TQObject */,
		const TQStringList a = TQStringList() /**< Flags */) :
		RecordConduitBase(o,n,a)
	{
	} ;
	virtual ~RecordConduit()
	{
	} ;

	virtual SyncProgress loadPC()
	{
		return Done;
	} ;

	virtual SyncProgress palmRecToPC()
	{
		return Done;
	}

	virtual SyncProgress pcRecToPalm()
	{
		return Done;
	}

	virtual SyncProgress cleanup()
	{
		return Done;
	}
} ;


#endif