/*
Gwenview: an image viewer
Copyright 2008 Aurélien Gâteau <agateau@kde.org>

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 TESTUTILS_H
#define TESTUTILS_H

#include <math.h>

// Qt
#include <QDir>
#include <QImage>
#include <QSignalSpy>
#include <QTest>

// KDE
#include <kdebug.h>
#include <kurl.h>


/*
 * This file contains simple helpers to access test files
 */

inline QString pathForTestFile(const QString& name) {
	return QString("%1/%2").arg(KDESRCDIR).arg(name);
}

inline KUrl urlForTestFile(const QString& name) {
	KUrl url;
	url.setPath(pathForTestFile(name));
	return url;
}

inline QString pathForTestOutputFile(const QString& name) {
	return QString("%1/%2").arg(QDir::currentPath()).arg(name);
}

inline KUrl urlForTestOutputFile(const QString& name) {
	KUrl url;
	url.setPath(pathForTestOutputFile(name));
	return url;
}

inline bool waitForSignal(const QSignalSpy& spy, int timeout = 5) {
	for (int x = 0; x < timeout; ++x) {
		if (spy.count() > 0) {
			return true;
		}
		QTest::qWait(1000);
	}
	return false;
}

inline bool fuzzyImageCompare(const QImage& img1, const QImage& img2) {
	if (img1.size() != img2.size()) {
		kWarning() << "Different sizes" << img1.size() << img2.size();
		return false;
	}
	if (img1.format() != img2.format()) {
		kWarning() << "Different formats" << img1.format() << img2.format();
		return false;
	}

	for(int posY = 0; posY < img1.height(); ++posY) {
		for (int posX = 0; posX < img2.width(); ++posX) {
			if (!(int)abs((double)img1.pixel(posX, posY) - img2.pixel(posX, posY)) > 2) {
				kWarning() << "Different at" << QPoint(posX, posY);
				return false;
			}
		}
	}
	return true;
}

/**
 * Returns the url of the remote url dir if remote test dir was successfully
 * set up.
 * If testFile is valid, it is copied into the test dir.
 */
KUrl setUpRemoteTestDir(const QString& testFile = QString());

#endif /* TESTUTILS_H */