/***************************************************************************
 *   Copyright (C) 2005 by Joris Guisson                                   *
 *   joris.guisson@gmail.com                                               *
 *                                                                         *
 *   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; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.             *
 ***************************************************************************/
#ifndef BTDATACHECKER_H
#define BTDATACHECKER_H

#include <util/bitset.h>
#include "datacheckerlistener.h"
#include <libktorrent_export.h>

class TQString;


namespace bt 
{
	class Torrent;
	

	/**
	 * @author Joris Guisson
	 * 
	 * Checks which data is downloaded, given a torrent and a file or directory containing
	 * files of the torrent.
	*/
	class LIBKTORRENT_EXPORT DataChecker
	{
	public:
		DataChecker();	
		virtual ~DataChecker();
	
		/// Set the listener
		void setListener(DataCheckerListener* l) {listener = l;}
		
		/**
		 * Check to see which chunks have been downloaded of a torrent, and which chunks fail.
		 * The corresponding bitsets should be filled with this information.
		 * If anything goes wrong and Error should be thrown. 
		 * @param path path to the file or dir (this needs to end with the name suggestion of the torrent)
		 * @param tor The torrent
		 * @param dnddir DND dir, optional argument if we know this
		 */
		virtual void check(const TQString & path,const Torrent & tor,const TQString & dnddir) = 0;
		
		/**
		 * Get the BitSet representing all the downloaded chunks.
		 */
		const BitSet & getDownloaded() const {return downloaded;}
		
		/**
		 * Get the BitSet representing all the failed chunks.
		 */
		const BitSet & getFailed() const {return failed;}
		
		/// Get the listener
		DataCheckerListener* getListener() {return listener;}
	protected:
		BitSet failed,downloaded;
		DataCheckerListener* listener;
	};

}

#endif
